Files
EOS/tests/test_elecpricefixed.py
T
Bobby NoelteandGitHub ba76087db9 feat: electricity fee provider framework and generic providers (#1235)
Add new provider class for electricity fees providers.

Add the generic providers:
- ElecFeeFixed
- ElecFeeImport

The providers provide predictions for:

- elecfee_consumption_amt_wh:
  Total fixed fee for consumed energy per Wh [amount/Wh]. This is the accumulation of all
  fixed per-Wh fees payable on "consumed energy - such as network charge, concession fee,
  and electricity charge - into a single amount.
- elecfee_consumption_percent_amt:
  Total fixed surcharge on consumed energy, given as a percentage of the monetary amount
  already charged for that energy [%]. This is the accumulation of all percentage-based
  surcharges payable on top of the consumed-energy fee - such as VAT - into a single
  percentage. This is a percentage of the fee amount, not a per-Wh rate.
- elecfee_feedin_amt_wh:
  Total fixed deduction from feed-in energy per Wh [amount/Wh]. This is the accumulation of
  all fixed per-Wh charges deducted from feed-in energy - such as metering fees or
  grid-operator handling "charges - into a single amount. Applied after the percentage-based
  deduction, i.e. it reduces the price by a flat amount per Wh rather than by a share of the
  raw price.
- elecfee_feedin_percent_amt:
  Total percentage deducted from the raw feed-in price (spot price) [%]. This is the
  accumulation of all percentage-based deductions payable on the feed-in tariff - such as a
  marketing or balancing fee retained by the aggregator - into a single percentage. It is
  applied as `raw_price * (100 - percent) / 100`, i.e. it scales down the raw price rather
  than adding a surcharge to it.

A new _apply_fee() method is added to the base class for ElecPrice and FeedInTariff to be used to
add the fees in a consistent way. Fees are taken from the active ElecFee provider and applied
to the raw prices given to the _apply_fee() method.

The optional application of fees is added to:

- ElecPriceAkkudoktor
- ElecPriceFixed
- ElecPriceEnergyCharts
- ElecPriceSMARD
- FeedInTariffEnergyCharts
- FeedInTariffFixed
- FeedInTariffSMARD

The import providers ElecPriceImport and FeedInTariffImport do not apply fees by intentention.

The following providers currently do not handle fees defined by ElecFee:

- ElecPriceTibber
- FeedInTariffAkkudoktor
- FeedInTariffDvhubOnline
- FeedInTariffTibber

The tests for this feature are either added or existing tests are extended.

The documentation was extended for the electricity fee provider settings.

Besides this feature further improvements are added:

* feat: add SMARD quarter-hour electricty price and feed-in tariff provider

* feat: to_series method for TimeWindows and ValueTimeWindows

  Additional to to_array the time window sequence can now also produce a pandas series.
  Test have been extended to cover the series generation.

* feat: use time windows in fixed feedin tariff provider

  Feedin tariff can now be configured by time windows - not a single value.

* feat: EOSdash select for PVLib inverters and modules

  Provide PVLib inverter and module names in config selection.

* feat: EOSdash lazy select for big option sets

  Add a new form for lazy selection of big option sets. Filtering and
  generation of the option set is done server-side.

* fix: use raw data for ETS/ median prediction

  Use to raw time series data for ETS/ median prediction to avoid interference
  by e.g. dynamic grid charges.

* fix: EOSdash config drops by type only on details resolve

  Drop configuration by type and path. Prevents dropping of configuration items
  with same type and level but different path.

* fix: EOSdash configuration section closes on update

  Open section if searching or if last update touched this category — including
  updates on deeply nested sub-fields.

* chore: make elecfeefixed, elecpricefixed and feedintarifffixed warn about no windows and default to 0

  Missining configuration creates default 0 value and a warning instead of an exception.

* fix: test setup for providers

  Reset db state on each test run.

* chore: improve config option naming for elecpricefixed.

* chore: adapt elecpricefixed test to changed time_windows naming

* chore: factorized common price provider helpers to priceabc.py

  Factorized common price provider helpers to priceabc.py. Add tests for these helpers.
  Reduce/ change testing of elecpriceabc.py and feedintariffabc.py to cover
  only specifics. Rest of testing is already covered by test_priceabc.py.

* chore: update version

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2026-08-23 02:26:16 +02:00

278 lines
10 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
"""Tests for fixed electricity price prediction module."""
import asyncio
import json
from pathlib import Path
from unittest.mock import Mock, patch
import numpy as np
import pandas as pd
import pytest
from akkudoktoreos.config.configabc import ValueTimeWindow, ValueTimeWindowSequence
from akkudoktoreos.core.cache import CacheFileStore
from akkudoktoreos.core.coreabc import get_ems
from akkudoktoreos.prediction.elecpricefixed import (
ElecPriceFixed,
ElecPriceFixedCommonSettings,
)
from akkudoktoreos.utils.datetimeutil import Duration, to_datetime
DIR_TESTDATA = Path(__file__).absolute().parent.joinpath("testdata")
FILE_TESTDATA_ELECPRICEFIXED_CONFIG_JSON = DIR_TESTDATA.joinpath("elecpricefixed_config.json")
class TestElecPriceFixedCommonSettings:
"""Tests for ElecPriceFixedCommonSettings model."""
def test_create_settings_with_windows(self):
"""Test creating settings with time windows."""
settings_dict = {
"elecprice_marketprice_amt_kwh": {
"windows": [
{
"start_time": "00:00",
"duration": "8 hours",
"value": 0.288
},
{
"start_time": "08:00",
"duration": "16 hours",
"value": 0.34
}
]
}
}
settings = ElecPriceFixedCommonSettings(**settings_dict)
assert settings is not None
assert settings.elecprice_marketprice_amt_kwh is not None
assert settings.elecprice_marketprice_amt_kwh.windows is not None
assert len(settings.elecprice_marketprice_amt_kwh.windows) == 2
def test_create_settings_without_windows(self):
"""Test creating settings without time windows."""
settings = ElecPriceFixedCommonSettings()
assert settings.elecprice_marketprice_amt_kwh is not None
assert settings.elecprice_marketprice_amt_kwh.windows == []
@pytest.fixture
def provider(config_eos):
"""Fixture to create a ElecPriceFixed provider instance."""
# Create settings and assign to config
config_eos.merge_settings_from_dict(
{
"elecprice": {
"provider": "ElecPriceFixed",
},
}
)
# Create time windows
elecprice_marketprice_amt_kwh = ValueTimeWindowSequence(
windows=[
ValueTimeWindow(
start_time="00:00",
duration="8 hours",
value=0.288
),
ValueTimeWindow(
start_time="08:00",
duration="16 hours",
value=0.34
)
]
)
config_eos.elecprice.elecpricefixed = ElecPriceFixedCommonSettings(elecprice_marketprice_amt_kwh=elecprice_marketprice_amt_kwh)
provider = ElecPriceFixed()
assert provider.enabled()
provider._db_reset_state()
return provider
@pytest.fixture
def cache_store():
"""A pytest fixture that creates a new CacheFileStore instance for testing."""
return CacheFileStore()
class TestElecPriceFixed:
"""Tests for ElecPriceFixed provider."""
def test_provider_id(self, provider):
"""Test provider ID returns correct value."""
assert provider.provider_id() == "ElecPriceFixed"
def test_singleton_instance(self, provider):
"""Test that ElecPriceFixed behaves as a singleton."""
another_instance = ElecPriceFixed()
assert provider is another_instance
def test_invalid_provider(self, provider, monkeypatch):
"""Test requesting an unsupported provider."""
monkeypatch.setenv("EOS_ELECPRICE__ELECPRICE_PROVIDER", "<invalid>")
provider.config.reset_settings()
assert not provider.enabled()
@pytest.mark.asyncio
async def test_update_data_15min_intervals(self, provider, config_eos):
"""Test updating data with 15-minute intervals (900s)."""
ems_eos = get_ems()
start_dt = to_datetime("2024-01-01 00:00:00", in_timezone="Europe/Berlin")
ems_eos.set_start_datetime(start_dt)
config_eos.prediction.hours = 10 # spans both windows: 00:0010:00 = 40 intervals
await provider.update_data(force_enable=True, force_update=True)
# 10 hours * 4 intervals per hour = 40 intervals
assert len(provider) == 40
records = provider.records
# Check timestamps are on 15-minute boundaries
for record in records:
assert record.date_time.minute in (0, 15, 30, 45)
assert record.date_time.second == 0
# First 32 intervals: 00:0008:00, night rate (8h * 4 = 32)
for i in range(32):
assert abs(records[i].elecprice_marketprice_wh - 0.000288) < 1e-6, (
f"Expected night rate at interval {i}, got {records[i].elecprice_marketprice_wh}"
)
# Remaining 8 intervals: 08:0010:00, day rate (2h * 4 = 8)
for i in range(32, 40):
assert abs(records[i].elecprice_marketprice_wh - 0.00034) < 1e-6, (
f"Expected day rate at interval {i}, got {records[i].elecprice_marketprice_wh}"
)
@pytest.mark.asyncio
async def test_update_data_without_config(self, caplog, provider, config_eos):
"""Test update_data fails without configuration."""
# Remove elecpricefixed settings
config_eos.elecprice.elecpricefixed = {}
with caplog.at_level("WARNING"):
await provider.update_data(force_enable=True, force_update=True)
assert "No time windows configured for `elecprice_marketprice_raw_wh`" in caplog.text
@pytest.mark.asyncio
async def test_update_data_without_elecprice_marketprice_amt_kwh(self, caplog, provider, config_eos):
"""Test update_data fails without time windows."""
# Set empty time windows
empty_settings = ElecPriceFixedCommonSettings(elecprice_marketprice_amt_kwh=ValueTimeWindowSequence(windows=[]))
config_eos.elecprice.elecpricefixed = empty_settings
with caplog.at_level("WARNING"):
await provider.update_data(force_enable=True, force_update=True)
assert "No time windows configured for `elecprice_marketprice_raw_wh`" in caplog.text
@pytest.mark.asyncio
async def test_key_to_array_resampling(self, provider, config_eos):
"""Test that key_to_array can resample to different intervals."""
# Provider provides 15-minutes data
ems_eos = get_ems()
start_dt = to_datetime("2024-01-01 00:00:00", in_timezone="Europe/Berlin")
ems_eos.set_start_datetime(start_dt)
config_eos.prediction.hours = 24
await provider.update_data(force_enable=True, force_update=True)
# Get data as hourly array (original)
hourly_array = await provider.key_to_array(
key="elecprice_marketprice_wh",
start_datetime=start_dt,
end_datetime=start_dt.add(hours=24),
fill_method="ffill",
)
assert len(hourly_array) == 24
assert abs(hourly_array[0] - 0.000288) < 1e-6 # Night rate
assert abs(hourly_array[8] - 0.00034) < 1e-6 # Day rate
# Resample to 15-minute intervals
quarter_hour_array = await provider.key_to_array(
key="elecprice_marketprice_wh",
start_datetime=start_dt,
end_datetime=start_dt.add(hours=24),
interval="15 minutes",
fill_method="ffill",
)
assert len(quarter_hour_array) == 96 # 24 * 4
# First 4 15-min intervals should be night rate
for i in range(4):
assert abs(quarter_hour_array[i] - 0.000288) < 1e-6
# Resample to 30-minute intervals
half_hour_array = await provider.key_to_array(
key="elecprice_marketprice_wh",
start_datetime=start_dt,
end_datetime=start_dt.add(hours=24),
interval="30 minutes",
fill_method="ffill",
)
assert len(half_hour_array) == 48 # 24 * 2
# First 2 30-min intervals should be night rate
for i in range(2):
assert abs(half_hour_array[i] - 0.000288) < 1e-6
class TestElecPriceFixedIntegration:
"""Integration tests for ElecPriceFixed."""
@pytest.mark.skip(reason="For development only")
async def test_fixed_price_development(self, config_eos):
"""Test fixed price provider with real configuration."""
# Create provider with config
provider = ElecPriceFixed()
# Setup realistic test scenario
ems_eos = get_ems()
start_dt = to_datetime("2024-01-01 00:00:00", in_timezone="Europe/Berlin")
ems_eos.set_start_datetime(start_dt)
# Configure with realistic German electricity prices (2024)
elecprice_marketprice_amt_kwh = ValueTimeWindowSequence(
windows=[
ValueTimeWindow(
start_time="00:00",
duration="8 hours",
value=0.288 # Night rate
),
ValueTimeWindow(
start_time="08:00",
duration="16 hours",
value=0.34 # Day rate
)
]
)
config_eos.elecprice.elecpricefixed = ElecPriceFixedCommonSettings(elecprice_marketprice_amt_kwh=elecprice_marketprice_amt_kwh)
config_eos.prediction.hours = 168 # 7 days
# Update data
await provider.update_data(force_enable=True, force_update=True)
# Verify data
expected_intervals = 168 * 4 # 7 days * 24h * 4 intervals
assert len(provider) == expected_intervals
# Save configuration for documentation
config_data = {
"elecprice_marketprice_amt_kwh": [
{
"start_time": str(window.start_time),
"duration": str(window.duration),
"value": window.value
}
for window in config_eos.elecprice.elecpricefixed.elecprice_marketprice_amt_kwh.windows
]
}
with FILE_TESTDATA_ELECPRICEFIXED_CONFIG_JSON.open("w", encoding="utf-8") as f:
json.dump(config_data, f, indent=4)