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>

src/akkudoktoreos/adapter/adapter.py

@@ -1,4 +1,4 @@
-from typing import TYPE_CHECKING, Optional, Union
+from typing import Optional, Union
 
 from pydantic import Field, computed_field, field_validator
 
@@ -10,9 +10,6 @@ from akkudoktoreos.adapter.homeassistant import (
 from akkudoktoreos.adapter.nodered import NodeREDAdapter, NodeREDAdapterCommonSettings
 from akkudoktoreos.config.configabc import SettingsBaseModel
 
-if TYPE_CHECKING:
-    adapter_providers: list[str]
-
 
 class AdapterCommonSettings(SettingsBaseModel):
     """Adapter Configuration."""
@@ -38,8 +35,9 @@ class AdapterCommonSettings(SettingsBaseModel):
     @computed_field  # type: ignore[prop-decorator]
     @property
     def providers(self) -> list[str]:
-        """Available electricity price provider ids."""
-        return adapter_providers
+        """Available adapter provider ids."""
+        adapter_provider_ids = [provider.provider_id() for provider in adapter_providers()]
+        return adapter_provider_ids
 
     # Validators
     @field_validator("provider", mode="after")
@@ -47,48 +45,39 @@ class AdapterCommonSettings(SettingsBaseModel):
     def validate_provider(cls, value: Optional[list[str]]) -> Optional[list[str]]:
         if value is None:
             return value
+        adapter_provider_ids = [provider.provider_id() for provider in adapter_providers()]
         for provider_id in value:
-            if provider_id not in adapter_providers:
+            if provider_id not in adapter_provider_ids:
                 raise ValueError(
-                    f"Provider '{value}' is not a valid adapter provider: {adapter_providers}."
+                    f"Provider '{value}' is not a valid adapter provider: {adapter_provider_ids}."
                 )
         return value
 
 
-class Adapter(AdapterContainer):
-    """Adapter container to manage multiple adapter providers.
-
-    Attributes:
-        providers (List[Union[PVForecastAkkudoktor, WeatherBrightSky, WeatherClearOutside]]):
-            List of forecast provider instances, in the order they should be updated.
-            Providers may depend on updates from others.
-    """
-
-    providers: list[
-        Union[
-            HomeAssistantAdapter,
-            NodeREDAdapter,
-        ]
-    ] = Field(default_factory=list, json_schema_extra={"description": "List of adapter providers"})
-
-
 # Initialize adapter providers, all are singletons.
 homeassistant_adapter = HomeAssistantAdapter()
 nodered_adapter = NodeREDAdapter()
 
 
-def get_adapter() -> Adapter:
-    """Gets the EOS adapter data."""
-    # Initialize Adapter instance with providers in the required order
-    # Care for provider sequence as providers may rely on others to be updated before.
-    adapter = Adapter(
-        providers=[
-            homeassistant_adapter,
-            nodered_adapter,
+def adapter_providers() -> list[Union["HomeAssistantAdapter", "NodeREDAdapter"]]:
+    """Return list of adapter providers."""
+    global homeassistant_adapter, nodered_adapter
+
+    return [
+        homeassistant_adapter,
+        nodered_adapter,
+    ]
+
+
+class Adapter(AdapterContainer):
+    """Adapter container to manage multiple adapter providers."""
+
+    providers: list[
+        Union[
+            HomeAssistantAdapter,
+            NodeREDAdapter,
         ]
+    ] = Field(
+        default_factory=adapter_providers,
+        json_schema_extra={"description": "List of adapter providers"},
     )
-    return adapter
-
-
-# Valid adapter providers
-adapter_providers = [provider.provider_id() for provider in get_adapter().providers]

src/akkudoktoreos/adapter/homeassistant.py

@@ -10,12 +10,12 @@ from pydantic import Field, computed_field, field_validator
 
 from akkudoktoreos.adapter.adapterabc import AdapterProvider
 from akkudoktoreos.config.configabc import SettingsBaseModel
+from akkudoktoreos.core.coreabc import get_adapter
 from akkudoktoreos.core.emplan import (
     DDBCInstruction,
     FRBCInstruction,
 )
 from akkudoktoreos.core.ems import EnergyManagementStage
-from akkudoktoreos.devices.devices import get_resource_registry
 from akkudoktoreos.utils.datetimeutil import to_datetime
 
 # Supervisor API endpoint and token (injected automatically in add-on container)
@@ -29,8 +29,6 @@ HEADERS = {
 
 HOMEASSISTANT_ENTITY_ID_PREFIX = "sensor.eos_"
 
-resources_eos = get_resource_registry()
-
 
 class HomeAssistantAdapterCommonSettings(SettingsBaseModel):
     """Common settings for the home assistant adapter."""
@@ -146,8 +144,6 @@ class HomeAssistantAdapterCommonSettings(SettingsBaseModel):
     def homeassistant_entity_ids(self) -> list[str]:
         """Entity IDs available at Home Assistant."""
         try:
-            from akkudoktoreos.adapter.adapter import get_adapter
-
             adapter_eos = get_adapter()
             result = adapter_eos.provider_by_id("HomeAssistant").get_homeassistant_entity_ids()
         except:
@@ -159,8 +155,6 @@ class HomeAssistantAdapterCommonSettings(SettingsBaseModel):
     def eos_solution_entity_ids(self) -> list[str]:
         """Entity IDs for optimization solution available at EOS."""
         try:
-            from akkudoktoreos.adapter.adapter import get_adapter
-
             adapter_eos = get_adapter()
             result = adapter_eos.provider_by_id("HomeAssistant").get_eos_solution_entity_ids()
         except:
@@ -172,8 +166,6 @@ class HomeAssistantAdapterCommonSettings(SettingsBaseModel):
     def eos_device_instruction_entity_ids(self) -> list[str]:
         """Entity IDs for energy management instructions available at EOS."""
         try:
-            from akkudoktoreos.adapter.adapter import get_adapter
-
             adapter_eos = get_adapter()
             result = adapter_eos.provider_by_id(
                 "HomeAssistant"