mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-09-11 10:26:38 +00: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>
7.8 KiB
7.8 KiB
Feed In Tariff Prediction Configuration
:::{table} feedintariff :widths: 10 20 10 5 5 30 :align: left
| Name | Environment Variable | Type | Read-Only | Default | Description |
|---|---|---|---|---|---|
| dvhubonline | EOS_FEEDINTARIFF__DVHUBONLINE |
FeedInTariffDvhubOnlineCommonSettings |
rw |
required |
DvhubOnline feed in tariff provider settings. |
| energycharts | EOS_FEEDINTARIFF__ENERGYCHARTS |
FeedInTariffEnergyChartsCommonSettings |
rw |
required |
EnergyCharts feed in tariff provider settings. |
| feedintarifffixed | EOS_FEEDINTARIFF__FEEDINTARIFFFIXED |
FeedInTariffFixedCommonSettings |
rw |
required |
Fixed feed in tariff provider settings. |
| feedintariffimport | EOS_FEEDINTARIFF__FEEDINTARIFFIMPORT |
FeedInTariffImportCommonSettings |
rw |
required |
Feed in tarif import provider settings. |
| provider | EOS_FEEDINTARIFF__PROVIDER |
Optional[str] |
rw |
None |
Feed in tariff provider id of provider to be used. |
| providers | list[str] |
ro |
N/A |
Available feed in tariff provider ids. | |
| smard | EOS_FEEDINTARIFF__SMARD |
FeedInTariffSMARDCommonSettings |
rw |
required |
SMARD feed in tariff provider settings. |
| ::: |
Example Input
{
"feedintariff": {
"provider": "FeedInTariffFixed",
"feedintarifffixed": {
"feed_in_tariff_amt_kwh": {
"windows": []
}
},
"feedintariffimport": {
"import_file_path": null,
"import_json": null
},
"dvhubonline": {
"base_url": "https://dvhub.online",
"zone": "DE-LU"
},
"energycharts": {
"bidding_zone": "DE-LU"
},
"smard": {}
}
}
Example Output
{
"feedintariff": {
"provider": "FeedInTariffFixed",
"feedintarifffixed": {
"feed_in_tariff_amt_kwh": {
"windows": []
}
},
"feedintariffimport": {
"import_file_path": null,
"import_json": null
},
"dvhubonline": {
"base_url": "https://dvhub.online",
"zone": "DE-LU"
},
"energycharts": {
"bidding_zone": "DE-LU"
},
"smard": {},
"providers": [
"FeedInTariffAkkudoktor",
"FeedInTariffDvhubOnline",
"FeedInTariffEnergyCharts",
"FeedInTariffFixed",
"FeedInTariffImport",
"FeedInTariffSMARD",
"FeedInTariffTibber"
]
}
}
Settings for SMARD feed-in prices shared with elecprice.smard
:::{table} feedintariff::smard :widths: 10 10 5 5 30 :align: left
| Name | Type | Read-Only | Default | Description |
|---|---|---|---|---|
| ::: |
Example Input/Output
{
"feedintariff": {
"smard": {}
}
}
Common settings for feed in tariff data import from file or JSON string
:::{table} feedintariff::feedintariffimport :widths: 10 10 5 5 30 :align: left
| Name | Type | Read-Only | Default | Description |
|---|---|---|---|---|
| import_file_path | Union[str, pathlib.Path, NoneType] |
rw |
None |
Path to the file to import feed in tariff data from. |
| import_json | Optional[str] |
rw |
None |
JSON string, dictionary of feed in tariff forecast value lists. |
| ::: |
Example Input/Output
{
"feedintariff": {
"feedintariffimport": {
"import_file_path": null,
"import_json": "{\"fead_in_tariff_wh\": [0.000078, 0.000078, 0.000023]}"
}
}
}
Common settings for elecprice fixed price
:::{table} feedintariff::feedintarifffixed :widths: 10 10 5 5 30 :align: left
| Name | Type | Read-Only | Default | Description |
|---|---|---|---|---|
| feed_in_tariff_amt_kwh | ValueTimeWindowSequence |
rw |
required |
Sequence of time windows defining the electricity feed in tariff [amount/kWh]. If not provided, no fixed feed in tariff is applied. |
| ::: |
Example Input/Output
{
"feedintariff": {
"feedintarifffixed": {
"feed_in_tariff_amt_kwh": {
"windows": [
{
"start_time": "00:00:00.000000",
"duration": "8 hours",
"day_of_week": null,
"date": null,
"locale": null,
"value": 0.028
},
{
"start_time": "08:00:00.000000",
"duration": "16 hours",
"day_of_week": null,
"date": null,
"locale": null,
"value": 0.034
}
]
}
}
}
}
Common settings for Energy-Charts feed-in tariff provider
:::{table} feedintariff::energycharts :widths: 10 10 5 5 30 :align: left
| Name | Type | Read-Only | Default | Description |
|---|---|---|---|---|
| bidding_zone | <enum 'EnergyChartsBiddingZones'> |
rw |
DE-LU |
Bidding Zone: 'AT', 'BE', 'CH', 'CZ', 'DE-LU', 'DE-AT-LU', 'DK1', 'DK2', 'FR', 'HU', 'IT-NORTH', 'NL', 'NO2', 'PL', 'SE4' or 'SI' |
| ::: |
Example Input/Output
{
"feedintariff": {
"energycharts": {
"bidding_zone": "DE-LU"
}
}
}
Common settings for the dvhub.online feed-in tariff provider
:::{table} feedintariff::dvhubonline :widths: 10 10 5 5 30 :align: left
| Name | Type | Read-Only | Default | Description |
|---|---|---|---|---|
| base_url | str |
rw |
https://dvhub.online |
Base URL of the dvhub.online price API. |
| zone | str |
rw |
DE-LU |
Bidding zone passed to the dvhub.online price API. |
| ::: |
Example Input/Output
{
"feedintariff": {
"dvhubonline": {
"base_url": "https://dvhub.online",
"zone": "DE-LU"
}
}
}