mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-09-11 10:26:38 +00:00
1abdd345c4
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>
9.1 KiB
9.1 KiB
Electricity Price Prediction Configuration
:::{table} elecprice :widths: 10 20 10 5 5 30 :align: left
| Name | Environment Variable | Type | Read-Only | Default | Description |
|---|---|---|---|---|---|
| akkudoktor | EOS_ELECPRICE__AKKUDOKTOR |
ElecPriceAkkudoktorCommonSettings |
rw |
required |
Akkudoktor electricity price provider settings. |
| elecpricefixed | EOS_ELECPRICE__ELECPRICEFIXED |
ElecPriceFixedCommonSettings |
rw |
required |
Fixed electricity price provider settings. |
| elecpriceimport | EOS_ELECPRICE__ELECPRICEIMPORT |
ElecPriceImportCommonSettings |
rw |
required |
Electricity price import provider settings. |
| energycharts | EOS_ELECPRICE__ENERGYCHARTS |
ElecPriceEnergyChartsCommonSettings |
rw |
required |
Energy Charts provider settings. |
| provider | EOS_ELECPRICE__PROVIDER |
Optional[str] |
rw |
None |
Electricity price provider id of provider to be used. |
| providers | list[str] |
ro |
N/A |
Available electricity price provider ids. | |
| smard | EOS_ELECPRICE__SMARD |
ElecPriceSMARDCommonSettings |
rw |
required |
SMARD electricity price provider settings. |
| tibber | EOS_ELECPRICE__TIBBER |
ElecPriceTibberCommonSettings |
rw |
required |
Tibber electricity price provider settings. |
| ::: |
Example Input
{
"elecprice": {
"provider": "ElecPriceAkkudoktor",
"akkudoktor": {},
"elecpricefixed": {
"elecprice_marketprice_amt_kwh": {
"windows": []
}
},
"elecpriceimport": {
"import_file_path": null,
"import_json": null
},
"energycharts": {
"bidding_zone": "DE-LU"
},
"smard": {
"filter_id": 4169,
"region": "DE"
},
"tibber": {
"access_token": null,
"home_id": null
}
}
}
Example Output
{
"elecprice": {
"provider": "ElecPriceAkkudoktor",
"akkudoktor": {},
"elecpricefixed": {
"elecprice_marketprice_amt_kwh": {
"windows": []
}
},
"elecpriceimport": {
"import_file_path": null,
"import_json": null
},
"energycharts": {
"bidding_zone": "DE-LU"
},
"smard": {
"filter_id": 4169,
"region": "DE"
},
"tibber": {
"access_token": null,
"home_id": null
},
"providers": [
"ElecPriceAkkudoktor",
"ElecPriceEnergyCharts",
"ElecPriceFixed",
"ElecPriceImport",
"ElecPriceSMARD",
"ElecPriceTibber"
]
}
}
Common settings for the Tibber electricity price provider
:::{table} elecprice::tibber :widths: 10 10 5 5 30 :align: left
| Name | Type | Read-Only | Default | Description |
|---|---|---|---|---|
| access_token | Optional[str] |
rw |
None |
Tibber API access token. |
| home_id | Optional[str] |
rw |
None |
Optional Tibber home id. If omitted, the first home with a subscription is used. |
| ::: |
Example Input/Output
{
"elecprice": {
"tibber": {
"access_token": "tibber_pat_...",
"home_id": "00000000-0000-0000-0000-000000000000"
}
}
}
Common settings for the direct SMARD electricity-price provider
:::{table} elecprice::smard :widths: 10 10 5 5 30 :align: left
| Name | Type | Read-Only | Default | Description |
|---|---|---|---|---|
| filter_id | int |
rw |
4169 |
SMARD filter id for the German/Luxembourg day-ahead price. |
| region | str |
rw |
DE |
SMARD market region used in the chart-data endpoint. |
| ::: |
Example Input/Output
{
"elecprice": {
"smard": {
"filter_id": 4169,
"region": "DE"
}
}
}
Common settings for Energy Charts electricity price provider
:::{table} elecprice::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
{
"elecprice": {
"energycharts": {
"bidding_zone": "AT"
}
}
}
Common settings for elecprice data import from file or JSON String
:::{table} elecprice::elecpriceimport :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 elecprice data from. |
| import_json | Optional[str] |
rw |
None |
JSON string, dictionary of electricity price forecast value lists. |
| ::: |
Example Input/Output
{
"elecprice": {
"elecpriceimport": {
"import_file_path": null,
"import_json": "{\"elecprice_marketprice_wh\": [0.0003384, 0.0003318, 0.0003284]}"
}
}
}
Common configuration settings for fixed electricity pricing
This model defines a fixed electricity price schedule using a sequence of time windows. Each window specifies a time interval and the electricity price applicable during that interval.
:::{table} elecprice::elecpricefixed :widths: 10 10 5 5 30 :align: left
| Name | Type | Read-Only | Default | Description |
|---|---|---|---|---|
| elecprice_marketprice_amt_kwh | ValueTimeWindowSequence |
rw |
required |
Sequence of time windows defining the fixed price schedule. If not provided, no fixed pricing is applied. |
| ::: |
Example Input/Output
{
"elecprice": {
"elecpricefixed": {
"elecprice_marketprice_amt_kwh": {
"windows": [
{
"start_time": "00:00:00.000000",
"duration": "8 hours",
"day_of_week": null,
"date": null,
"locale": null,
"value": 0.288
},
{
"start_time": "08:00:00.000000",
"duration": "16 hours",
"day_of_week": null,
"date": null,
"locale": null,
"value": 0.34
}
]
}
}
}
}
Common configuration settings for Akkodoktor electricity pricing
:::{table} elecprice::akkudoktor :widths: 10 10 5 5 30 :align: left
| Name | Type | Read-Only | Default | Description |
|---|---|---|---|---|
| ::: |
Example Input/Output
{
"elecprice": {
"akkudoktor": {}
}
}