mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-09-11 10:26:38 +00:00
fix: unify mypy environments for local checks and CI (#1291)
The isolated pre-commit mypy hook previously omitted runtime type information that make mypy used, hiding errors involving dependencies such as Pydantic and Pendulum. Makefile, pre-commit and CI now run the same full-project typing policy in the development environment defined by uv.lock. - Use uv run --locked --exact --extra dev and the same mypy arguments for Makefile and the local hook. Check all of src and tests, including on configuration-only changes. - Pin Python 3.13 for local development and the pre-commit CI job, and install the locked pre-commit version in CI. - Disable incremental analysis because existing Pendulum cache state changes mypy 2.3.1 diagnostics. Document the policy, the performance tradeoff and the existing typing debt. - Add a regression test that exercises Makefile, the hook and the CI command in a temporary project, accepting valid dependency types and detecting deliberate Pydantic/Pendulum assignment errors. Resolve the newly detected mypy diagnostics. - Enable the numpydantic and Pydantic mypy plugins, retaining strict Pydantic constructor typing with init_typed = true. Validate raw/coercible payloads through model_validate. - Propagate concrete record, provider and time-window types through generic collections, factories and lookup methods. Preserve runtime field inspection and generated time-window documentation. - Align Pendulum annotations with actual factory/arithmetic results while retaining Pydantic validation adapters at runtime. Correct optional values, array boundaries, REST handlers and plotting interfaces. - Add pinned scipy-stubs and types-psutil, update uv.lock, and supply the plugins' dependencies. - Add runtime regression coverage for validated path defaults, normalized time-series metadata, generic field inspection, invalid timestamps and unsupported provider imports. Runtime and compatibility details: - Validate path defaults as Path objects while retaining raw string defaults needed by migration serialization with exclude_defaults. - Normalize feed-in tariff lists and default charge rates to NumPy arrays; reject missing timestamps/uninitialized values explicitly. Importing into a provider without import support returns HTTP 400. - Public JSON schemas and OpenAPI structure match main (excluding the generated version). Signed-off-by: dr-dimitry Signed-off-by: dr-dimitry Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> Co-authored-by: dr-dimitri <87113560+dr-dimitri@users.noreply.github.com> Co-authored-by: Normann <github@koldrack.com>
This commit is contained in:
co-authored by
dr-dimitri
Normann
parent
5b584cbb57
commit
1abdd345c4
@@ -3,6 +3,7 @@ import os
|
||||
import shutil
|
||||
import sys
|
||||
from pathlib import Path
|
||||
from types import SimpleNamespace
|
||||
from unittest.mock import patch
|
||||
|
||||
import pytest
|
||||
@@ -16,6 +17,36 @@ DIR_TEST_GENERATED = DIR_TESTDATA / "docs" / "_generated"
|
||||
GITHUB_ACTIONS = os.getenv("GITHUB_ACTIONS")
|
||||
|
||||
|
||||
def test_config_documentation_requires_a_timezone_name(
|
||||
monkeypatch: pytest.MonkeyPatch, tmp_path: Path
|
||||
) -> None:
|
||||
monkeypatch.syspath_prepend(str(DIR_PROJECT_ROOT))
|
||||
from scripts import generate_config_md
|
||||
|
||||
monkeypatch.setattr(generate_config_md, "to_datetime", lambda: SimpleNamespace(timezone_name=None))
|
||||
output = tmp_path / "config.md"
|
||||
with pytest.raises(RuntimeError, match="Documentation generation requires a timezone name"):
|
||||
generate_config_md.write_to_file(output, "Configuration documentation")
|
||||
assert not output.exists()
|
||||
|
||||
|
||||
def test_generic_time_windows_keep_nested_documentation(monkeypatch):
|
||||
from akkudoktoreos.config.configabc import TimeWindowSequence
|
||||
|
||||
monkeypatch.syspath_prepend(str(DIR_PROJECT_ROOT))
|
||||
from scripts import generate_config_md
|
||||
|
||||
monkeypatch.setattr(generate_config_md, "documented_types", set())
|
||||
monkeypatch.setattr(generate_config_md, "undocumented_types", {})
|
||||
markdown = generate_config_md.generate_config_table_md(
|
||||
TimeWindowSequence, ["time_windows"], "", toplevel=True, extra_config=True
|
||||
)
|
||||
assert "`list[akkudoktoreos.config.configabc.TimeWindow]`" in markdown
|
||||
assert ":::{table} time_windows::windows::list" in markdown
|
||||
assert "| start_time | `Time`" in markdown
|
||||
assert "| duration | `Duration`" in markdown
|
||||
|
||||
|
||||
@pytest.mark.skipif(GITHUB_ACTIONS == "true", reason="Skipped on GitHub Actions - TODO!")
|
||||
def test_openapi_spec_current(config_eos, set_other_timezone):
|
||||
"""Verify the openapi spec hasn´t changed."""
|
||||
|
||||
Reference in New Issue
Block a user