Changelog

All notable changes to pyetm are documented here.

[2.0.4] - 14-10-2026

Scenario.update(scenario_id=...) now switches scenario.session to the new session. Previously it kept returning the old one until the scenario was reloaded. Pointing a scenario at a new session saves a version in MyETM, as now documented.
Scenario.update() no longer fails with AttributeError: property 'version' of 'Scenario' object has no setter when MyETM includes the version tag in its response. Only fields declared on the model are applied from the response.

Saving scenarios to MyETM works again on the stable 2025-01 version. pyetm now sends the request shape its target expects: 2025-01 reads the saved scenario attributes from the top level, newer engines from a saved_scenario root key. Affected Scenario.new(), Session.save() and any Scenarios.from_excel() run whose MAIN rows are not marked session=TRUE, which previously failed with 422: title: is missing, scenario_id: is missing.
A scenario that cannot be saved to MyETM no longer passes silently. The failure is recorded on the scenario and reported by Scenarios.from_excel().
Saving a scenario on any non-production environment (a stable tag such as 2025-01, beta, or a custom deployment) now tells MyETM which one.

pyetm now ships a py.typed marker, so type checkers (mypy, pyright) pick up its inline type hints when the package is imported (PEP 561).

Partial updates to inputs, sortables, and custom curves no longer fail wholesale on a single invalid entry. Invalid entries are excluded from the API payload while the valid ones are still applied. Excluded custom curves are reported as warnings instead of raising ScenarioError.

Fixed a file-descriptor leak that could exhaust the OS open-file limit (ulimit) when many sessions were created (#205). ETMSession now closes its event loop on close()and can be used as a context manager (with ETMSession(...) as session:).

Capacity tables (electricity_capacities, district_heating_capacities, hydrogen_capacities, network_gas_capacities) are classified as annual exports, not hourly output curves. Fetch them with get_annual_export() / get_annual_exports() instead of get_hourly_curve().

Capacity tables are only available on modern engines (pro). On the stable 2025-01 tag they do not exist; get_annual_export() returns None in that case.