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>

tests/test_version.py

@@ -2,11 +2,22 @@
 import subprocess
 import sys
 from pathlib import Path
+from typing import Optional, Union
 
 import pytest
 import yaml
 
-from akkudoktoreos.core.version import _version_calculate, _version_hash
+from akkudoktoreos.core.version import (
+    ALLOWED_SUFFIXES,
+    DIR_PACKAGE_ROOT,
+    EXCLUDED_DIR_PATTERNS,
+    EXCLUDED_FILES,
+    HashConfig,
+    _version_calculate,
+    _version_hash,
+    collect_files,
+    hash_files,
+)
 
 DIR_PROJECT_ROOT = Path(__file__).parent.parent
 GET_VERSION_SCRIPT = DIR_PROJECT_ROOT / "scripts" / "get_version.py"
@@ -14,11 +25,166 @@ BUMP_DEV_SCRIPT = DIR_PROJECT_ROOT / "scripts" / "bump_dev_version.py"
 UPDATE_SCRIPT = DIR_PROJECT_ROOT / "scripts" / "update_version.py"
 
 
+# --- Git helpers ---
+
+def get_git_tracked_files(repo_path: Path) -> Optional[set[Path]]:
+    """Get set of all files tracked by git in the repository.
+
+    Returns None if not a git repository or git command fails.
+    """
+    try:
+        result = subprocess.run(
+            ["git", "ls-files"],
+            cwd=repo_path,
+            capture_output=True,
+            text=True,
+            check=True
+        )
+        # Convert relative paths to absolute paths
+        tracked_files = {
+            (repo_path / line.strip()).resolve()
+            for line in result.stdout.splitlines()
+            if line.strip()
+        }
+        return tracked_files
+    except (subprocess.CalledProcessError, FileNotFoundError):
+        return None
+
+
+def is_git_repository(path: Path) -> bool:
+    """Check if path is inside a git repository."""
+    try:
+        subprocess.run(
+            ["git", "rev-parse", "--git-dir"],
+            cwd=path,
+            capture_output=True,
+            check=True
+        )
+        return True
+    except (subprocess.CalledProcessError, FileNotFoundError):
+        return False
+
+
+def get_git_root(path: Path) -> Optional[Path]:
+    """Get the root directory of the git repository containing path."""
+    try:
+        result = subprocess.run(
+            ["git", "rev-parse", "--show-toplevel"],
+            cwd=path,
+            capture_output=True,
+            text=True,
+            check=True
+        )
+        return Path(result.stdout.strip())
+    except (subprocess.CalledProcessError, FileNotFoundError):
+        return None
+
+
+def check_files_in_git(
+    files: list[Path],
+    base_path: Optional[Path] = None
+) -> tuple[list[Path], list[Path]]:
+    """Check which files are tracked by git.
+
+    Args:
+        files: List of files to check
+        base_path: Base path to check for git repository (uses first file's parent if None)
+
+    Returns:
+        Tuple of (tracked_files, untracked_files)
+
+    Example:
+        >>> files = collect_files(config)
+        >>> tracked, untracked = check_files_in_git(files)
+        >>> if untracked:
+        ...     print(f"Warning: {len(untracked)} files not in git")
+    """
+    if not files:
+        return [], []
+
+    check_path = base_path or files[0].parent
+
+    assert is_git_repository(check_path)
+
+    git_root = get_git_root(check_path)
+    if not git_root:
+        return [], files
+
+    git_tracked = get_git_tracked_files(git_root)
+    if git_tracked is None:
+        return [], files
+
+    tracked = [f for f in files if f in git_tracked]
+    untracked = [f for f in files if f not in git_tracked]
+
+    return tracked, untracked
+
+
 # --- Helper to create test files ---
 def write_file(path: Path, content: str):
     path.write_text(content, encoding="utf-8")
     return path
 
+# -- Test version calculation ---
+
+def test_version_hash() -> None:
+    """Test which files are used for version hash calculation."""
+
+    watched_paths = [DIR_PACKAGE_ROOT]
+
+    # Collect files
+    config = HashConfig(
+        paths=watched_paths,
+        allowed_suffixes=ALLOWED_SUFFIXES,
+        excluded_dir_patterns=EXCLUDED_DIR_PATTERNS,
+        excluded_files=EXCLUDED_FILES
+    )
+
+    files = collect_files(config)
+    hash_digest = hash_files(files)
+
+    # Check git
+    tracked, untracked = check_files_in_git(files, DIR_PACKAGE_ROOT)
+    tracked_files: list[Path] = tracked
+    untracked_files: list[Path] = untracked
+
+    if untracked_files:
+        error_msg = f"\n{'='*60}"
+        error_msg += f"Version Hash Inspection"
+        error_msg += f"{'='*60}\n"
+        error_msg += f"Hash: {hash_digest}"
+        error_msg += f"Based on {len(files)} files:\n"
+
+        error_msg += f"OK: {len(tracked_files)} files tracked by git:\n"
+        for i, file_path in enumerate(files, 1):
+            try:
+                rel_path = file_path.relative_to(DIR_PACKAGE_ROOT)
+                status = ""
+                if file_path in untracked_files:
+                    continue
+                elif file_path in tracked_files:
+                    status = " [tracked]"
+                error_msg += f"  {i:3d}. {rel_path}{status}\n"
+            except ValueError:
+                error_msg += f"  {i:3d}. {file_path}\n"
+
+        error_msg += f"Warning: {len(untracked_files)} files not tracked by git:\n"
+        for i, file_path in enumerate(files, 1):
+            try:
+                rel_path = file_path.relative_to(DIR_PACKAGE_ROOT)
+                status = ""
+                if file_path in untracked_files:
+                    status = " [NOT IN GIT]"
+                elif file_path in tracked_files:
+                    continue
+                error_msg += f"  {i:3d}. {rel_path}{status}\n"
+            except ValueError:
+                error_msg += f"  {i:3d}. {file_path}\n"
+
+        error_msg += f"\n{'='*60}\n"
+
+        pytest.fail(error_msg)
+
 
 # --- Test version helpers ---
 def test_version_non_dev(monkeypatch):
@@ -38,7 +204,7 @@ def test_version_dev_precision_8(monkeypatch):
 
     result = _version_calculate()
 
-    # compute expected suffix
+    # Compute expected suffix using the same logic as _version_calculate
     hash_value = int(fake_hash, 16)
     expected_digits = str(hash_value % (10 ** 8)).zfill(8)
 
@@ -60,12 +226,17 @@ def test_version_dev_precision_8_different_hash(monkeypatch):
 
     result = _version_calculate()
 
+    # Compute expected suffix using the same logic as _version_calculate
     hash_value = int(fake_hash, 16)
     expected_digits = str(hash_value % (10 ** 8)).zfill(8)
+
     expected = f"0.2.0.dev{expected_digits}"
 
     assert result == expected
     assert len(expected_digits) == 8
+    assert result.startswith("0.2.0.dev")
+    assert result == expected
+
 
 
 # --- 1️⃣ Test get_version.py ---