feat: add register_converter API - #354
Merged
Merged
Conversation
Contributor
hallvictoria
marked this pull request as ready for review
July 24, 2026 17:11
Contributor
There was a problem hiding this comment.
Pull request overview
Introduces a new public azure.functions.register_converter() API to let integration packages (notably azure-functions-durable) replace converters for a small allow-list of durable-related bindings, without reaching into private internals.
Changes:
- Add
_OVERRIDABLE_BINDINGSallow-list andregister_converter()implementation inazure/functions/meta.py. - Export
register_converterfrom theazure.functionspackage surface (__init__.py/__all__). - Add unit tests covering allow-list enforcement and overwrite behavior.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| tests/test_meta.py | Adds tests for the new register_converter API (allow-list + overwrite semantics + export surface). |
| azure/functions/meta.py | Implements allow-listed converter registration/override API on top of the binding registry. |
| azure/functions/init.py | Exposes register_converter as part of the public azure.functions API. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
gavin-aguiar
approved these changes
Jul 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
azure-functions-durablev2.x SDK uses the durabletask gRPC programming model, which requires orchestration and entity trigger outputs to be encoded as string datums rather than json. Previously there was no public way to override a registered converter.This change introduces a minimal, stable public API that allows
azure-functions-durable(and only that package) to replace durable-related converters without touching any private internals ofazure-functions.Only 4 binding names are permitted to be overridden:
orchestrationTrigger,entityTrigger,activityTrigger,durableClient.This does not change:
azure-functions-durableitself