v0.5.0

Frequenz Client Base Library Release Notes

Summary

The main features of this release is the new base class for API clients, gRPC exception wrappers and a new utility function to call stub methods.

Upgrading

• channel.parse_grpc_uri() takes an extra argument, the channel type (which can be either grpclib.client.Channel or grpcio.aio.Channel).

New Features

• Add a exception module to provide client exceptions, including gRPC errors with one subclass per gRPC error status code.
• channel.parse_grpc_uri() can now be used with grpcio too.
• A new BaseApiClient class is introduced to provide a base class for API clients. It is strongly recommended to use this class as a base class for all API clients.
• A new call_stub_method() function to simplify calling stub methods, converting gRPC errors to ApiClientErrors, checking if the client is connected and optionally wrapping the response.

What's Changed

• Clear the release notes by @llucax in #53
• Add client exceptions by @llucax in #55
• Bump the required group with 7 updates by @dependabot in #57
• Add grpcio support to parse_grpc_uri() by @llucax in #54
• Add a BaseApiClient class by @llucax in #56
• Improve type-checking for _grpchacks by @llucax in #59
• Add a function to call gRPC stubs and wrap errors by @llucax in #58
• Bump docker/build-push-action from 5 to 6 by @dependabot in #61
• Bump the required group with 9 updates by @dependabot in #60
• Bump brettcannon/check-for-changed-files from 1.2.0 to 1.2.1 by @dependabot in #62
• Prepare release notes for the 0.5 release by @llucax in #63

Full Changelog: v0.4.0...v0.5.0