Add database support for measurements and historic prediction data. (#848)

The database supports backend selection, compression, incremental data load,
automatic data saving to storage, automatic vaccum and compaction.

Make SQLite3 and LMDB database backends available.

Update tests for new interface conventions regarding data sequences,
data containers, data providers. This includes the measurements provider and
the prediction providers.

Add database documentation.

The fix includes several bug fixes that are not directly related to the database
implementation but are necessary to keep EOS running properly and to test and
document the changes.

* fix: config eos test setup

  Make the config_eos fixture generate a new instance of the config_eos singleton.
  Use correct env names to setup data folder path.

* fix: startup with no config

  Make cache and measurements complain about missing data path configuration but
  do not bail out.

* fix: soc data preparation and usage for genetic optimization.

  Search for soc measurments 48 hours around the optimization start time.
  Only clamp soc to maximum in battery device simulation.

* fix: dashboard bailout on zero value solution display

  Do not use zero values to calculate the chart values adjustment for display.

* fix: openapi generation script

  Make the script also replace data_folder_path and data_output_path to hide
  real (test) environment pathes.

* feat: add make repeated task function

  make_repeated_task allows to wrap a function to be repeated cyclically.

* chore: removed index based data sequence access

  Index based data sequence access does not make sense as the sequence can be backed
  by the database. The sequence is now purely time series data.

* chore: refactor eos startup to avoid module import startup

  Avoid module import initialisation expecially of the EOS configuration.
  Config mutation, singleton initialization, logging setup, argparse parsing,
  background task definitions depending on config and environment-dependent behavior
  is now done at function startup.

* chore: introduce retention manager

  A single long-running background task that owns the scheduling of all periodic
  server-maintenance jobs (cache cleanup, DB autosave, …)

* chore: canonicalize timezone name for UTC

  Timezone names that are semantically identical to UTC are canonicalized to UTC.

* chore: extend config file migration for default value handling

  Extend the config file migration handling values None or nonexisting values
  that will invoke a default value generation in the new config file. Also
  adapt test to handle this situation.

* chore: extend datetime util test cases

* chore: make version test check for untracked files

  Check for files that are not tracked by git. Version calculation will be
  wrong if these files will not be commited.

* chore: bump pandas to 3.0.0

  Pandas 3.0 now performs inference on the appropriate resolution (a.k.a. unit)
  for the output dtype which may become datetime64[us] (before it was ns). Also
  numeric dtype detection is now more strict which needs a different detection for
  numerics.

* chore: bump pydantic-settings to 2.12.0

  pydantic-settings 2.12.0 under pytest creates a different behaviour. The tests
  were adapted and a workaround was introduced. Also ConfigEOS was adapted
  to allow for fine grain initialization control to be able to switch
  off certain settings such as file settings during test.

* chore: remove sci learn kit from dependencies

  The sci learn kit is not strictly necessary as long as we have scipy.

* chore: add documentation mode guarding for sphinx autosummary

  Sphinx autosummary excecutes functions. Prevent exceptions in case of pure doc
  mode.

* chore: adapt docker-build CI workflow to stricter GitHub handling

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>

scripts/generate_config_md.py

@@ -14,7 +14,8 @@ from loguru import logger
 from pydantic.fields import ComputedFieldInfo, FieldInfo
 from pydantic_core import PydanticUndefined
 
-from akkudoktoreos.config.config import ConfigEOS, GeneralSettings, get_config
+from akkudoktoreos.config.config import ConfigEOS, default_data_folder_path
+from akkudoktoreos.core.coreabc import get_config, singletons_init
 from akkudoktoreos.core.pydantic import PydanticBaseModel
 from akkudoktoreos.utils.datetimeutil import to_datetime
 
@@ -361,12 +362,6 @@ def generate_config_md(file_path: Optional[Union[str, Path]], config_eos: Config
     Returns:
         str: The Markdown representation of the configuration spec.
     """
-    # Fix file path for general settings to not show local/test file path
-    GeneralSettings._config_file_path = Path(
-        "/home/user/.config/net.akkudoktoreos.net/EOS.config.json"
-    )
-    GeneralSettings._config_folder_path = config_eos.general.config_file_path.parent
-
     markdown = ""
 
     if file_path:
@@ -446,6 +441,19 @@ def write_to_file(file_path: Optional[Union[str, Path]], config_md: str):
         '/home/user/.local/share/net.akkudoktor.eos/output/eos.log',
         config_md
     )
+    # Assure pathes are set to default for documentation
+    replacements = [
+        ("data_folder_path", "/home/user/.local/share/net.akkudoktoreos.net"),
+        ("data_output_path", "/home/user/.local/share/net.akkudoktoreos.net/output"),
+        ("config_folder_path", "/home/user/.config/net.akkudoktoreos.net"),
+        ("config_file_path", "/home/user/.config/net.akkudoktoreos.net/EOS.config.json"),
+    ]
+    for key, value in replacements:
+        config_md = re.sub(
+            rf'("{key}":\s*)"[^"]*"',
+            rf'\1"{value}"',
+            config_md
+        )
 
     # Assure timezone name does not leak to documentation
     tz_name = to_datetime().timezone_name
@@ -477,16 +485,31 @@ def main():
     )
 
     args = parser.parse_args()
-    config_eos = get_config()
+
+    # Ensure we are in documentation mode
+    ConfigEOS._force_documentation_mode = True
+
+    # Make minimal config to make the generation reproducable
+    config_eos = get_config(init={
+            "with_init_settings": True,
+            "with_env_settings": False,
+            "with_dotenv_settings": False,
+            "with_file_settings": False,
+            "with_file_secret_settings": False,
+        })
+
+    # Also init other singletons to get same list of e.g. providers
+    singletons_init()
 
     try:
         config_md = generate_config_md(args.output_file, config_eos)
-
     except Exception as e:
         print(f"Error during Configuration Specification generation: {e}", file=sys.stderr)
         # keep throwing error to debug potential problems (e.g. invalid examples)
         raise e
-
+    finally:
+        # Ensure we are out of documentation mode
+        ConfigEOS._force_documentation_mode = False
 
 if __name__ == "__main__":
     main()

scripts/generate_openapi.py

@@ -19,32 +19,44 @@ import json
 import os
 import sys
 
-from fastapi.openapi.utils import get_openapi
-
+from akkudoktoreos.core.coreabc import get_config
 from akkudoktoreos.server.eos import app
 
 
 def generate_openapi() -> dict:
-    """Generate the OpenAPI specification.
+    # Make minimal config to make the generation reproducable
+    config_eos = get_config(init={
+            "with_init_settings": True,
+            "with_env_settings": False,
+            "with_dotenv_settings": False,
+            "with_file_settings": False,
+            "with_file_secret_settings": False,
+        })
 
-    Returns:
-        openapi_spec (dict): OpenAPI specification.
-    """
-    openapi_spec = get_openapi(
-        title=app.title,
-        version=app.version,
-        openapi_version=app.openapi_version,
-        description=app.description,
-        routes=app.routes,
+    openapi_spec = app.openapi()
+
+    config_schema = (
+        openapi_spec
+        .get("components", {})
+        .get("schemas", {})
+        .get("ConfigEOS", {})
+        .get("properties", {})
     )
 
-    # Fix file path for general settings to not show local/test file path
-    general = openapi_spec["components"]["schemas"]["ConfigEOS"]["properties"]["general"]["default"]
-    general["config_file_path"] = "/home/user/.config/net.akkudoktoreos.net/EOS.config.json"
-    general["config_folder_path"] = "/home/user/.config/net.akkudoktoreos.net"
-    # Fix file path for logging settings to not show local/test file path
-    logging = openapi_spec["components"]["schemas"]["ConfigEOS"]["properties"]["logging"]["default"]
-    logging["file_path"] = "/home/user/.local/share/net.akkudoktoreos.net/output/eos.log"
+    # ---- General settings ----
+    general = config_schema.get("general", {}).get("default")
+    if general:
+        general.update({
+            "config_file_path": "/home/user/.config/net.akkudoktoreos.net/EOS.config.json",
+            "config_folder_path": "/home/user/.config/net.akkudoktoreos.net",
+            "data_folder_path": "/home/user/.local/share/net.akkudoktoreos.net",
+            "data_output_path": "/home/user/.local/share/net.akkudoktoreos.net/output",
+        })
+
+    # ---- Logging settings ----
+    logging_cfg = config_schema.get("logging", {}).get("default")
+    if logging_cfg:
+        logging_cfg["file_path"] = "/home/user/.local/share/net.akkudoktoreos.net/output/eos.log"
 
     return openapi_spec