Frequenz-sdk

Frequenz Python SDK Release Notes

Summary

This is a minor release with just a few bug fixes but also one breaking change in the `ConfigManagingActor`.

Upgrading

- The `ConfigManagingActor` now only reacts to `CREATE` and `MODIFY` events. `DELETE` is not supported anymore and are ignored.
- Remove the `event_types` argument from the `ConfigManagingActor` constructor.

Bug Fixes

- Fix bugs with `ConfigManagingActor`:
- Raising unhandled exceptions when any file in config directory was deleted.
- Raising unhandled exception if not all config files exist.
- Eliminate recursive actor crashes when all config files were missing.


What's Changed
* Fix `ConfigManagingActor` raising unhandled exceptions when file doesn't exist by ela-kotulska-frequenz in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1116
* Prepare release notes for v1.0.0-rc1400 by llucax in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1121


**Full Changelog**: https://github.com/frequenz-floss/frequenz-sdk-python/compare/v1.0.0-rc1302...v1.0.0-rc1400

Frequenz Python SDK Release Notes

Improvements

* Many tasks, senders and receivers now have proper names for easier debugging.
* The resample log was improved to show more details.
* The `Sample` class now has a nice `__str__` representation.

Bug Fixes

- Fix a bug in the resampler that could end up with an *IndexError: list index out of range* exception when a new resampler was added while awaiting the existing resampler to finish resampling.


What's Changed
* Fix IndexError: list index out of range in resampler by llucax in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1117
* Small debugging enhancements by Marenz in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1119


**Full Changelog**: https://github.com/frequenz-floss/frequenz-sdk-python/compare/v1.0.0-rc1301...v1.0.0-rc1302

Frequenz Python SDK Release Notes

Bug Fixes

* Fix bug with `LoggingConfigUpdater` not updating root logger level.
* The `frequenz-quantities` dependency requirement was widened to allow any v1.x version (it was pinned to `1.0.0rc3` before).


What's Changed
* Widen the quantities version requirement by llucax in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1110
* Update to repo-config v0.11.0 by llucax in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1111
* Bump types-setuptools from 74.0.0.20240831 to 75.5.0.20241122 by dependabot in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1114
* Fix ConfigLoggingUpdater not changing root logging level by ela-kotulska-frequenz in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1112
* Bump the required group with 3 updates by dependabot in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1113
* Update release notes for release 1.0.0-rc1301 by llucax in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1115


**Full Changelog**: https://github.com/frequenz-floss/frequenz-sdk-python/compare/v1.0.0-rc1300...v1.0.0-rc1301

Frequenz Python SDK Release Notes

Summary

<!-- Here goes a general summary of what this release is about -->

Upgrading

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

New Features

* The `MicrogridApiClient` was updated to the latest version.

Bug Fixes

<!-- Here goes notable bug fixes that are worth a special mention or explanation -->


What's Changed
* Reset release notes by ela-kotulska-frequenz in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1108
* Update microgrid client to latest version by Marenz in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1109


**Full Changelog**: https://github.com/frequenz-floss/frequenz-sdk-python/compare/v1.0.0-rc1200...v1.0.0-rc1300

Frequenz Python SDK Release Notes

Upgrading

New Features

- `frequenz.sdk.config.load_config()` can now use a base schema to customize even further how data is loaded.



What's Changed
* Clear release notes by llucax in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1100
* Check that load_config raises ValidationError if config is None by ela-kotulska-frequenz in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1102
* Allow passing a `base_schema` to `load_config()` by llucax in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1103
* Restore support for marshmallow_dataclass by ela-kotulska-frequenz in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1106
* Prepare release notes for next release by ela-kotulska-frequenz in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1107


**Full Changelog**: https://github.com/frequenz-floss/frequenz-sdk-python/compare/v1.0.0-rc1100...v1.0.0-rc1200

Frequenz Python SDK Release Notes

Summary

This release focus on improving the config management, but also introduces other minor improvements and fixes an important bug.

Upgrading

- The `ConfigManagingActor` now takes multiple configuration files as input, and the argument was renamed from `config_file` to `config_files`. If you are using this actor, please update your code. For example:

python
Old
actor = ConfigManagingActor(config_file="config.toml")
New
actor = ConfigManagingActor(config_files=["config.toml"])


- The `MovingWindow` now take all arguments as keyword-only to avoid mistakes.
- The `frequenz-quantities` dependency was bumped to `1.0.0rc3`.
- The `ComponentMetricsRequest` now produces a channel name without the `start_date` if the `start_date` is `None`. If you are somehow relying on the old behavior, please update your code.

New Features

- The `ConfigManagingActor` can now take multiple configuration files as input, allowing to override default configurations with custom configurations.
- A new `frequenz.sdk.config.load_config()` function is available to load configurations using `marshmallow_dataclass`es with correct type hints.
- Implement and standardize logging configuration with the following changes:
* Add `LoggerConfig` and `LoggingConfig` to standardize logging configuration.
* Create `LoggingConfigUpdater` to handle runtime config updates.
* Support individual log level settings for each module.

Bug Fixes

- Fixes an issue where PV and EV system bounds were not available to the Power Manager sometimes when requested after startup.


What's Changed
* Clear release notes by shsms in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1090
* config: Allow reading from multiple files by llucax in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1091
* Store the original `Component` and `Connection` in the component graph by llucax in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1093
* Bump the required group across 1 directory with 12 updates by dependabot in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1094
* Implement and standardize logging configuration via config file by ela-kotulska-frequenz in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1095
* Bump dependency to 1.0.0rc3 by ela-kotulska-frequenz in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1096
* Add a function to load configurations with correct type hints by llucax in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1097
* Improve `ComponentMetricsRequest` documentation by llucax in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1092
* Update bound-streaming channels to resend latest to new receivers by shsms in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1098
* Prepare release notes for rc1100 by llucax in https://github.com/frequenz-floss/frequenz-sdk-python/pull/1099


**Full Changelog**: https://github.com/frequenz-floss/frequenz-sdk-python/compare/v1.0.0-rc1000...v1.0.0-rc1100