Frequenz-channels

Frequenz channels Release Notes

Upgrading

- `FileWatcher`: The file polling mechanism is now forced by default. This provides reliable and consistent file monitoring on network file systems (e.g., CIFS). However, it may have a performance impact on local file systems or when monitoring a large number of files.
- To disable file polling, set the `force_polling` parameter to `False`.
- The `polling_interval` parameter defines the interval for polling changes. This is relevant only when polling is enabled and defaults to 1 second.

New Features

- `Timer.reset()` now supports setting the interval and will restart the timer with the new interval.

Bug Fixes

- `FileWatcher`:
- Fixed `ready()` method to return False when an error occurs. Before this fix, `select()` (and other code using `ready()`) never detected the `FileWatcher` was stopped and the `select()` loop was continuously waking up to inform the receiver was ready.
- Reports file events correctly on network file systems like CIFS.

- `Timer.stop()` and `Timer.reset()` now immediately stop the timer if it is running. Before this fix, the timer would continue to run until the next interval.


What's Changed
* Timer: Add support for rearming timer with new interval by Marenz in https://github.com/frequenz-floss/frequenz-channels-python/pull/321
* Enable polling in file watcher by daniel-zullo-frequenz in https://github.com/frequenz-floss/frequenz-channels-python/pull/322


**Full Changelog**: https://github.com/frequenz-floss/frequenz-channels-python/compare/v1.1.2...v1.2.0

Frequenz channels Release Notes

Bug Fixes

- `FileWatcher`: Fixed `ready()` method to return False when an error occurs. Before this fix, `select()` (and other code using `ready()`) never detected the `FileWatcher` was stopped and the `select()` loop was continuously waking up to inform the receiver was ready.


What's Changed
* Clear release notes by llucax in https://github.com/frequenz-floss/frequenz-channels-python/pull/314
* Bump the required group across 1 directory with 19 updates by dependabot in https://github.com/frequenz-floss/frequenz-channels-python/pull/316
* Fix ready() method in FileWatcher by daniel-zullo-frequenz in https://github.com/frequenz-floss/frequenz-channels-python/pull/318
* Update release notes for release 1.1.2 by llucax in https://github.com/frequenz-floss/frequenz-channels-python/pull/319


**Full Changelog**: https://github.com/frequenz-floss/frequenz-channels-python/compare/v1.1.1...v1.1.2

Frequenz channels Release Notes

Summary

This release improves the documentation on `Receiver.filter`.


What's Changed
* Clear release notes by shsms in https://github.com/frequenz-floss/frequenz-channels-python/pull/312
* Improves the documentation on `Receiver.filter` by llucax in https://github.com/frequenz-floss/frequenz-channels-python/pull/313


**Full Changelog**: https://github.com/frequenz-floss/frequenz-channels-python/compare/v1.1.0...v1.1.1

Frequenz channels Release Notes

Summary

In addition to the new `LatestValueCache` and the ability to `filter` messages on `Receiver`s, this release introduces two "Experimental" features for providing interconnections between channels.

New Features

- The `LatestValueCache` class, which used to be internal to the Frequenz SDK, is now available through the channels package.

- **Experimental**: `RelaySender`, which is a `Sender` that forwards the messages sent to it, to multiple senders.

- **Experimental**: `Pipe`, which provides a pipe between two channels, by connecting a `Receiver` to a `Sender`.

- `Receiver`s now have a `filter` method that applies a filter function on the messages on a receiver.


What's Changed
* Clear release notes by llucax in https://github.com/frequenz-floss/frequenz-channels-python/pull/296
* Bump the required group with 10 updates by dependabot in https://github.com/frequenz-floss/frequenz-channels-python/pull/299
* Bump markdown-svgbob from 202112.1022 to 202406.1023 by dependabot in https://github.com/frequenz-floss/frequenz-channels-python/pull/305
* Bump the required group with 10 updates by dependabot in https://github.com/frequenz-floss/frequenz-channels-python/pull/304
* Import the `LatestValueCache` implementation from the Frequenz SDK by shsms in https://github.com/frequenz-floss/frequenz-channels-python/pull/302
* Bump the required group with 2 updates by dependabot in https://github.com/frequenz-floss/frequenz-channels-python/pull/309
* Bump brettcannon/check-for-changed-files from 1.2.0 to 1.2.1 by dependabot in https://github.com/frequenz-floss/frequenz-channels-python/pull/308
* Bump docker/build-push-action from 5 to 6 by dependabot in https://github.com/frequenz-floss/frequenz-channels-python/pull/307
* Add abstractions for sharing messages between channels by shsms in https://github.com/frequenz-floss/frequenz-channels-python/pull/301
* Support filtering the messages on a receiver by shsms in https://github.com/frequenz-floss/frequenz-channels-python/pull/303
* Prepare for release v1.1.0 by shsms in https://github.com/frequenz-floss/frequenz-channels-python/pull/311


**Full Changelog**: https://github.com/frequenz-floss/frequenz-channels-python/compare/v1.0.1...v1.1.0

Frequenz channels Release Notes

Enhancements

- The API documentation now shows the type of symbol in the table of contents.

Bug Fixes

- Fix logger for the `Broadcast` channel (the log messages were missing the level, timestamp, etc.).


What's Changed
* Clear release notes by llucax in https://github.com/frequenz-floss/frequenz-channels-python/pull/291
* Update project status classifier by llucax in https://github.com/frequenz-floss/frequenz-channels-python/pull/292
* Bump the required group with 7 updates by dependabot in https://github.com/frequenz-floss/frequenz-channels-python/pull/293
* Bump the required group with 4 updates by dependabot in https://github.com/frequenz-floss/frequenz-channels-python/pull/294
* Fix the logger for the `Broadcast` channel by llucax in https://github.com/frequenz-floss/frequenz-channels-python/pull/295
* Fix the CI and add the symbol type to the docs ToC by llucax in https://github.com/frequenz-floss/frequenz-channels-python/pull/298


**Full Changelog**: https://github.com/frequenz-floss/frequenz-channels-python/compare/v1.0.0...v1.0.1

Frequenz channels Release Notes

Summary

This is the first stable release of the Frequenz channels library.

If you are **upgrading from the previous 1.0.0 pre-releases**, please look into the release notes for those versions to see the changes and upgrade instructions: