v1.0.0-beta.1

Frequenz channels Release Notes

Summary

The Timer now can be started with a delay and some channel attributes were made private.

Upgrading

• Anycast

  • The following public properties were removed (made private): limit, closed, deque, send_cv, recv_cv.

• Broadcast

  • The following public properties were removed (made private): name, closed, recv_cv, receivers.

New Features

• The arm64 architecture is now officially supported.

• The documentation was improved to:

  • Show signatures with types.
  • Show the inherited members.
  • Documentation for pre-releases are now published.
  • Show the full tag name as the documentation version.
  • All development branches now have their documentation published (there is no next version anymore).
  • Fix the order of the documentation versions.

• Broadcast

  • Added a resend_latest read-write property to get/set whether the latest message should be resent to new receivers.

• Timer

  • Timer(), Timer.timeout(), Timer.periodic() and Timer.reset() now take an optional start_delay option to make the timer start after some delay.

    This can be useful, for example, if the timer needs to be aligned to a particular time. The alternative to this would be to sleep() for the time needed to align the timer, but if the sleep() call gets delayed because the event loop is busy, then a re-alignment is needed and this could go on for a while. The only way to guarantee a certain alignment (with a reasonable precision) is to delay the timer start.

What's Changed

• Migrate to use repo-config by @llucax in #124
• Bump pylint from 2.17.3 to 2.17.4 by @dependabot in #125
• Bump pytest-mock from 3.10.0 to 3.11.1 by @dependabot in #126
• Bump mkdocs-material from 9.1.17 to 9.1.18 by @dependabot in #128
• Bump pytest from 7.3.1 to 7.4.0 by @dependabot in #127
• Bump mypy from 1.2.0 to 1.4.1 by @dependabot in #129
• Bump hypothesis from 6.80.0 to 6.80.1 by @dependabot in #130
• Bump actions/labeler from 4.2.0 to 4.3.0 by @dependabot in #131
• Bump black from 23.3.0 to 23.7.0 by @dependabot in #132
• Bump hypothesis from 6.80.1 to 6.81.1 by @dependabot in #133
• Bump pytest-asyncio from 0.21.0 to 0.21.1 by @dependabot in #135
• Improve documentation by @llucax in #136
• Bump sybil from 5.0.2 to 5.0.3 by @dependabot in #137
• Bump hypothesis from 6.81.1 to 6.81.2 by @dependabot in #138
• Bump mkdocs-material from 9.1.18 to 9.1.19 by @dependabot in #140
• Fix typo recever -> receiver by @Marenz in #139
• Bump hypothesis from 6.81.2 to 6.82.0 by @dependabot in #141
• Bump pylint from 2.17.4 to 2.17.5 by @dependabot in #143
• Bump mkdocs-material from 9.1.19 to 9.1.21 by @dependabot in #144
• Update to repo-config 0.4.0 by @Marenz in #142
• Bump hypothesis from 6.82.0 to 6.82.2 by @dependabot in #147
• Add optional start delay to Timer by @llucax in #145
• Bump hypothesis from 6.82.2 to 6.82.3 by @dependabot in #148
• Bump mypy from 1.4.1 to 1.5.0 by @dependabot in #149
• Bump hypothesis from 6.82.3 to 6.82.4 by @dependabot in #150
• Bump mypy from 1.5.0 to 1.5.1 by @dependabot in #152
• Bump hypothesis from 6.82.4 to 6.82.5 by @dependabot in #155
• Bump hypothesis from 6.82.5 to 6.82.6 by @dependabot in #157
• Bump mkdocs-material from 9.1.21 to 9.2.1 by @dependabot in #158
• Bump mkdocs-material from 9.2.1 to 9.2.3 by @dependabot in #159
• Update watchfiles requirement from <0.20.0,>=0.15.0 to >=0.15.0,<0.21.0 by @dependabot in #160
• Bump mkdocs-material from 9.2.3 to 9.2.5 by @dependabot in #161
• Bump hypothesis from 6.82.6 to 6.84.0 by @dependabot in #171
• Bump mkdocstrings[python] from 0.22.0 to 0.23.0 by @dependabot in #167
• Bump mkdocs-material from 9.2.5 to 9.2.8 by @dependabot in #172
• Bump hypothesis from 6.84.0 to 6.84.1 by @dependabot in #173
• Bump mkdocs-section-index from 0.3.5 to 0.3.6 by @dependabot in #174
• Bump actions/checkout from 3 to 4 by @dependabot in #170
• Bump pytest from 7.4.0 to 7.4.1 by @dependabot in #169
• Bump hypothesis from 6.84.1 to 6.84.2 by @dependabot in #175
• Replace obsolete types by @daniel-zullo-frequenz in #176
• Upgrade to repo-config v0.5.2 by @llucax in #153
• Bump mkdocs-literate-nav from 0.6.0 to 0.6.1 by @dependabot in #179
• Bump pytest from 7.4.1 to 7.4.2 by @dependabot in #178
• Bump mkdocs-material from 9.2.8 to 9.3.1 by @dependabot in #183
• Bump hypothesis from 6.84.2 to 6.84.3 by @dependabot in #181
• Bump black from 23.7.0 to 23.9.1 by @dependabot in #180
• Bump mkdocs-section-index from 0.3.6 to 0.3.7 by @dependabot in #184
• docs: Improve README and intro by @llucax in #189
• Document class and module attributes by @daniel-zullo-frequenz in #185
• Bump hypothesis from 6.84.3 to 6.86.2 by @dependabot in #192
• Bump mkdocs-material from 9.3.1 to 9.3.2 by @dependabot in #191
• Bump hypothesis from 6.86.2 to 6.87.1 by @dependabot in #200
• Bump pylint from 2.17.5 to 2.17.7 by @dependabot in #201
• Bump hypothesis from 6.87.1 to 6.87.3 by @dependabot in #206
• Make internal variable names private by @shsms in #213
• Bump hypothesis from 6.87.3 to 6.88.0 by @dependabot in #210
• Update watchfiles requirement from <0.21.0,>=0.15.0 to >=0.15.0,<0.22.0 by @dependabot in #211
• Bump mypy from 1.5.1 to 1.6.0 by @dependabot in #208
• Bump mypy from 1.6.0 to 1.6.1 by @dependabot in #216
• Bump pytest from 7.4.2 to 7.4.3 by @dependabot in #220
• Bump hypothesis from 6.88.0 to 6.88.1 by @dependabot in #214
• Bump pytest-mock from 3.11.1 to 3.12.0 by @dependabot in #217
• Bump mkdocs-section-index from 0.3.7 to 0.3.8 by @dependabot in #196
• Bump black from 23.9.1 to 23.10.1 by @dependabot in #219
• Make resend_latest a public attribute for Broadcast channels by @shsms in #221
• Update to repo-config v0.7.1 by @llucax in #223

Full Changelog: v0.16.0...v1.0.0-beta.1