v1.0.0-rc2201

Frequenz Python SDK Release Notes

Note

This version is just a re-publishing of version v1.0.0-rc2200, because we had some issue with publishing that versin to PyPI.

Summary

This is a major upgrade, as the underlying version of the microgrid API was changed to use v0.18.x instead.

Upgrading

• The SDK now depends on the frequenz-client-microgrid v0.18.x series.

  • Check the release notes for the client v0.18.
  • There were a lot of changes, so it might be also worth having a quick look at the microgrid API v0.17 and v0.18 releases.
  • Checking out the API common releases v0.6, v0.7, v0.8 might also be worthwhile, at least if you find any errors about renamed or missing types.
  • Although many of the changes in lower layer are hidden by the SDK, there are some changes that can't be hidden away. For example the Metric enum had some renames, and Component.component_id was renamed to Component.id. Also, there is a new component class hierarchy.

• ComponentGraph methods arguments were renamed to better reflect what they expect.

  • The components() method now uses matching_ids and matching_types instead of component_ids and component_categories respectively. matching_types takes types inheriting from Component instead of categories, for example Battery or BatteryInverter.
  • The connections() methods now take matching_sources and matching_destinations instead of start and end respectively. This is to match the new names in ComponentConnection.
  • All arguments for both methods can now receiver arbitrary iterables instead of sets, and can also accept a single value.

New Features

Bug Fixes

What's Changed

• Clear release notes by @shsms in #1301
• Update to use the microgrid API v0.18 by @llucax in #1283
• Bump pytest-asyncio from 1.2.0 to 1.3.0 by @dependabot[bot] in #1310
• Bump pydoclint from 0.7.6 to 0.8.3 by @dependabot[bot] in #1309
• Bump the patch group with 3 updates by @dependabot[bot] in #1304
• Bump pytest from 8.4.2 to 9.0.1 by @dependabot[bot] in #1307
• Merge 'v1.0.0-rc21xx' to v1.x.x by @shsms in #1314
• Minor improvements and cleanups by @llucax in #1293
• Bump mkdocstrings[python] from 0.30.1 to 1.0.0 by @dependabot[bot] in #1311
• Bump frequenz-floss/gh-action-nox from 1.0.1 to 1.1.0 in the compatible group by @dependabot[bot] in #1302
• Bump actions/checkout from 5 to 6 by @dependabot[bot] in #1303
• Bump the minor group across 1 directory with 9 updates by @dependabot[bot] in #1316
• Bump types-protobuf from 6.32.1.20250918 to 6.32.1.20251105 by @dependabot[bot] in #1318
• Bump the patch group with 2 updates by @dependabot[bot] in #1319
• Bump pylint from 3.3.8 to 4.0.4 by @dependabot[bot] in #1312
• Bump isort from 6.1.0 to 7.0.0 by @dependabot[bot] in #1290
• Bump mkdocs-gen-files from 0.5.0 to 0.6.0 by @dependabot[bot] in #1306

Full Changelog: v1.0.0-rc2104...v1.0.0-rc2201