#Note: v0.4.7

Several changes (see RELEASE_NOTES for details)

Author: mickolaua

Dockerfile

@@ -0,0 +1,39 @@
+FROM ubuntu:22.04
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y build-essential python3-pip virtualenv \
+    python3-venv sqlite3 libsqlite3-dev sqlcipher libsqlcipher-dev git
+
+# Set user, group, and create home directory
+ARG user=appuser
+ARG group=appuser
+ARG uid=1000
+ARG gid=1000
+RUN groupadd -g ${gid} ${group}
+RUN useradd -u ${uid} -g ${group} -s /bin/sh -m ${user}
+
+# Aliases for application and working directories
+ENV appdir=/home/${user}/app
+ENV workdir=/home/${user}/work
+
+WORKDIR ${appdir}
+
+# Copy project files to the application directory
+COPY aware aware
+COPY pyproject.toml .
+COPY MANIFEST.in .
+
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+# Create a new virtual environment, install dependencies, and AWARE
+RUN python3 -m venv .venv && . .venv/bin/activate && python -m pip install -U pip wheel setuptools .
+
+# Create entrypoint for application
+WORKDIR ${workdir}
+
+ENTRYPOINT [ "/bin/bash", "-c", "exec ${appdir}/.venv/bin/python -m aware \"${@}\"", "--" ]
+
+# Optional arguments (-t means run Telegram bot)
+
+CMD ["-t"]

RELEASE_NOTES

@@ -62,6 +62,24 @@ In this minor release:
 - Use default naming convention for table constraints for easier migration
 - Define declarative base in SQLAlchemy 2.0 style
 
+## v0.4.8
+
+- Fixed incorrect plot safe filename in plotting
+- Fixed absent default value for VOEvent parameters
+- Fixed survey name in finding chart from DSS2 to DSS2 R
+- Fixed Kafka client configuration (in test mode, auto.commit is disabled, and group.id
+ is empty; in production mode group.id is uniquely set at each run),
+
+- Added type hint for config options
+- Added new script for visibility plots
+- Updated find chart plot (added compass)
+- Updated visibility plot (main yaxis is altitude now; the Moon phase, and separation angle)
+- Restored alert rejection functionality (a new event matching previously rejected one, 
+will be also rejected; all matched alerts with currently rejected one, will be marked 
+as rejected in the database)
+- Added cache support for queries to SkyView, telescope list retrieval, subscribers querying, 
+and for displaying available telescopes
+
 
 # v0.3.0
 

aware/__version__.py

@@ -1,2 +1,2 @@
-__version__ = ("0", "4", "7")
+__version__ = ("0", "4", "8")
 __strversion__ = "{}.{}.{}".format(__version__)

aware/app.py

@@ -5,6 +5,7 @@
 from queue import Queue
 from threading import Lock, Thread
 from typing import Any, Callable, Sequence
+import uuid
 
 from .config import dev
 from .consumer.main import ConsumeLoop, prepare_consumer
@@ -23,15 +24,16 @@ def import_tg_hook() -> Callable[[tuple[Any], dict[str, Any]], Thread]:
 
 
 CONSUMER_CONFIG = {
-    "group.id": "lvk" if not dev.value else "lvk-test",
+    "group.id": "" if dev.value else uuid.uuid4().hex,
     # Infinitely read messages in development mode since the beginning of
     # the partition
-    "auto.offset.reset": "earliest" if dev.get_value() else "latest",
-    "enable.auto.commit": True,
+    "auto.offset.reset": "earliest" if dev.value else "latest",
+    "enable.auto.commit": False if dev.value else True,
     # Set maximum idle time out between reading topic records to 1 day
     # (in msec) to prevent application maximum poll interval exceeded
     "max.poll.interval.ms": 86_400_000,
 }
+# CONSUMER_CONFIG = {}
 
 
 class Application:

aware/cache.py

@@ -1,17 +1,105 @@
 """
 Author: Nicolai Pankov (colinsergesen@gmail.com)
 cache.py (c) 2023
-Desc: description
+Desc: Caching functions
 Created:  2023-03-05
-Modified: 2023-03-06
+Modified: 2024-02-22
 """
 
 from __future__ import annotations
+from typing import Any
 
-from diskcache import Cache, JSONDisk, Disk
+from diskcache import Cache, DEFAULT_SETTINGS, Disk
 from .config import CfgOption
+from .logger import log
+from sqlite3 import Error
+
+
+__all__ = ["cache_value"]
 
 
 cache_dir = CfgOption("cache_dir", ".cache", str)
+timeout = CfgOption("timeout", 60, float)
+expire = CfgOption("expire", 86400, float)
+
+
+def __access_cache():
+    """
+    Access the cache via calling this function, do not use global `Cache` object
+    since it may be not created due to SQL errors (e.g. database is blocked)
+    """
+    try:
+        cache = Cache(cache_dir.get_value(), timeout=timeout.value)
+    except Error as e:
+        log.debug("Error getting cache database: %s", e)
+
+        class EmptyCache:
+            def __init__(self, *args, **kwargs): ...
+
+            def set(self, *args, **kwargs): ...
+
+            def get(self, *args, **kwargs): ...
+
+            def __enter__(self): return self
+
+            def __exit__(self, *args, **kwargs): ...
+            
+        cache = EmptyCache()
+
+    return cache
+
+
+def write_cache(
+    key: str,
+    value: Any,
+    tag: str = "",
+    expire: float = expire.value,
+    retry: bool = True,
+):
+    global __access_cache
+    with __access_cache() as cache:
+        # Additional arguments to cache set
+        kws = {}
+
+        # File object
+        if hasattr(value, "read"):
+            kws["read"] = True
+
+        if tag is None:
+            kws["tag"] = key.title()
+
+        try:
+            cache.set(key, value, expire=expire, retry=retry, **kws)
+        except Exception as e:
+            if isinstance(e, KeyboardInterrupt):
+                raise
+            else:
+                log.error("Cache entry %s is not writable %s", key, e)
+
+
+def read_cache(
+    key: str,
+) -> Any:
+    global __access_cache
+    value = None
+    with __access_cache() as cache:
+        try:
+            value = cache.get(key)
+        except Exception as e:
+            if isinstance(e, KeyboardInterrupt):
+                raise
+            else:
+                log.error("Cache entry %s is not readable %s", key, e)
+
+    return value
+
 
-cache = Cache(cache_dir.get_value())
+def pop_cache(key: str):
+    try:
+        with __access_cache() as cache:
+            cache.pop(key)
+    except Exception as e:
+        if isinstance(e, KeyboardInterrupt):
+            raise
+        else:
+            log.error("Cache entry %s is not expirable %s", key, e)

aware/config.py

@@ -9,11 +9,13 @@
 import os
 import sys
 from pathlib import Path
-from typing import Any, Callable, Mapping, Sequence, TypeVar
+from typing import Any, Callable, Mapping, Sequence, TypeVar, Generic
 
 import dotenv
 import yaml
 
+import warnings
+
 
 BASE_DIR = os.path.dirname(os.path.dirname(__file__))
 ABS_DIR = os.path.abspath(BASE_DIR)
@@ -60,7 +62,7 @@ def load_config(
 __T = TypeVar("__T")
 
 
-class CfgOption:
+class CfgOption(Generic[__T]):
     """
     YAML config option.
 
@@ -74,15 +76,15 @@ class CfgOption:
         a function that processes and validates the value type
     """
 
-    def __init__(self, name: str, value: Any, typ: Callable[[Any], Any]) -> None:
+    def __init__(self, name: str, value: Any, typ: Callable[..., __T]) -> None:
         self._name = name
         self._value = value
         self.typ = typ
 
         # Get caller filename here or it will always return filename where is the base
         # class located
         self.__filename = inspect.currentframe().f_back.f_code.co_filename
- 
+
     def __get_aware_pkg_root(self) -> str:
         """
         Get the path to the AWARE root directory
@@ -125,7 +127,14 @@ def section(self) -> str:
         except IndexError:
             return ""
 
-    def get_value(self) -> Any:
+    def get_value(self) -> __T:
+        warnings.warn(
+            (
+                "get_value() considered deprecated in next releases, use value "
+                "property instead"
+            ),
+            DeprecationWarning,
+        )
         global cfg
         names = self.name.split(".")
 
@@ -138,12 +147,10 @@ def get_value(self) -> Any:
             return self.typ(val)
         else:
             return self.typ(self._value)
-        
 
     @property
-    def value(self) -> Any:
+    def value(self) -> __T:
         return self.get_value()
-    
 
     def _get_val_from_nested_dict(
         self, d: Mapping[Any, Any], names: Sequence[str]
@@ -157,11 +164,11 @@ def _get_val_from_nested_dict(
                 return d
 
         return None
-    
+
 
 def set_config_option_value(name: str, val: Any, typ: Callable = str):
     global cfg
-    
+
     # The option is in the submodule
     names = name.split(".")
     if len(names) > 1:
@@ -182,8 +189,14 @@ def set_config_option_value(name: str, val: Any, typ: Callable = str):
         cfg[name] = typ(val)
 
 
+# Development switch
 dev = CfgOption("dev", False, bool)
+
+# load .env files with defined environment variables, if available
 dot_env_path = CfgOption("dot_env_path", ".env", str)
-if dev.get_value():
+if dot_env_path.get_value():
     if not dotenv.load_dotenv(dotenv_path=dot_env_path.get_value(), verbose=True):
-        raise FileNotFoundError(".env file not found")
+        print(
+            f"No environment variables found in {dot_env_path.get_value()}",
+            file=sys.stderr,
+        )