v0.11.0

Frequenz Client Base Library Release Notes

Summary

Upgrading

• Updated interface and behavior for HMAC

  This introduces a new positional argument to parse_grpc_uri.
  If calling this function manually and passing ChannelOptions, it is recommended
  to switch to passing ChannelOptions via keyword argument.

• All parameters of the Streamers new_receiver method are now keyword-only arguments. This means that you must specify them by name when calling the method, e.g.:

  recv = streamer.new_receiver(max_size=50, warn_on_overflow=True)

New Features

• The streaming client, when using new_receiver(include_events=True), will now return a receiver that yields stream notification events, such as StreamStarted, StreamRetrying, and StreamFatalError. This allows you to monitor the state of the stream:

  recv = streamer.new_receiver(include_events=True)
  
  for msg in recv:
      match msg:
          case StreamStarted():
              print("Stream started")
          case StreamRetrying(delay, error):
              print(f"Stream stopped and will retry in {delay}: {error or 'closed'}")
          case StreamFatalError(error):
              print(f"Stream will stop because of a fatal error: {error}")
          case int() as output:
              print(f"Received message: {output}")

Bug Fixes

What's Changed

• Reset release notes by @florian-wagner-frequenz in #144
• Streamer: Write out events on the channels as well by @Marenz in #146
• Update release notes formatting by @Marenz in #147
• Improve streamer events by @llucax in #149
• Bump the patch group with 6 updates by @dependabot in #150
• Bump the minor group with 3 updates by @dependabot in #151
• Bump types-protobuf from 5.29.1.20250403 to 6.30.2.20250516 by @dependabot in #152
• Streaming: Make events optional by @Marenz in #154
• Change interface for HMAC by @florian-wagner-frequenz in #145
• Make parameters named of new_receiver by @Marenz in #155

Full Changelog: v0.10.0...v0.11.0