mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-11-13 09:13:30 +01:00
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>
71 lines
2.1 KiB
Python
71 lines
2.1 KiB
Python
"""Settings for logging.
|
|
|
|
Kept in an extra module to avoid cyclic dependencies on package import.
|
|
"""
|
|
|
|
from pathlib import Path
|
|
from typing import Optional
|
|
|
|
from pydantic import Field, computed_field, field_validator
|
|
|
|
from akkudoktoreos.config.configabc import SettingsBaseModel
|
|
from akkudoktoreos.core.logabc import LOGGING_LEVELS
|
|
|
|
|
|
class LoggingCommonSettings(SettingsBaseModel):
|
|
"""Logging Configuration."""
|
|
|
|
api_level: Optional[str] = Field(
|
|
default=None,
|
|
json_schema_extra={
|
|
"description": "Logging level for API response.",
|
|
"examples": [*LOGGING_LEVELS],
|
|
},
|
|
)
|
|
|
|
console_level: Optional[str] = Field(
|
|
default=None,
|
|
json_schema_extra={
|
|
"description": "Logging level for logging to console.",
|
|
"examples": [*LOGGING_LEVELS],
|
|
},
|
|
)
|
|
|
|
file_level: Optional[str] = Field(
|
|
default=None,
|
|
json_schema_extra={
|
|
"description": "Logging level for logging to file.",
|
|
"examples": [*LOGGING_LEVELS],
|
|
},
|
|
)
|
|
|
|
@computed_field # type: ignore[prop-decorator]
|
|
@property
|
|
def file_path(self) -> Optional[Path]:
|
|
"""Computed log file path based on data output path."""
|
|
try:
|
|
path = SettingsBaseModel.config.general.data_output_path / "eos.log"
|
|
except Exception:
|
|
# Config may not be fully set up
|
|
path = None
|
|
return path
|
|
|
|
# Validators
|
|
@field_validator("console_level", "file_level", mode="after")
|
|
@classmethod
|
|
def validate_level(cls, value: Optional[str]) -> Optional[str]:
|
|
"""Validate logging level string."""
|
|
if value is None:
|
|
# Nothing to set
|
|
return None
|
|
if isinstance(value, str):
|
|
level = value.upper()
|
|
if level == "NONE":
|
|
return None
|
|
if level not in LOGGING_LEVELS:
|
|
raise ValueError(f"Logging level {value} not supported")
|
|
value = level
|
|
else:
|
|
raise TypeError(f"Invalid {type(value)} of logging level {value}")
|
|
return value
|