Skip to content

feat: add converter registration hook #308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
hallvictoria wants to merge 1 commit into from
Closed

feat: add converter registration hook #308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions azure/functions/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
from ._http_asgi import AsgiMiddleware
from .kafka import KafkaEvent, KafkaConverter, KafkaTriggerConverter
from .mcp import MCPToolContext
from .meta import get_binding_registry
from .meta import get_binding_registry, register_converter, InConverter, OutConverter
from ._queue import QueueMessage
from ._servicebus import ServiceBusMessage
from ._sql import SqlRow, SqlRowList
Expand All @@ -46,6 +46,9 @@
__all__ = (
# Functions
'get_binding_registry',
'register_converter',
'InConverter',
'OutConverter',

# Generics.
'Context',
Expand Down Expand Up @@ -106,4 +109,4 @@
'McpPropertyType'
)

__version__ = '1.25.0b2'
__version__ = '1.25.0b3dev1'
35 changes: 31 additions & 4 deletions azure/functions/meta.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import datetime
import re
from typing import Dict, Optional, Union, Tuple, Mapping, Any
import logging

from ._jsonutils import json
from ._thirdparty import typing_inspect
Expand All @@ -14,6 +15,8 @@
try_parse_timedelta_with_formats
)

_logger = logging.getLogger('azure.functions.AsgiMiddleware')


def is_iterable_type_annotation(annotation: object, pytype: object) -> bool:
is_iterable_anno = (
Expand Down Expand Up @@ -90,14 +93,17 @@ def __new__(mcls, name, bases, dct, *,
trigger: Optional[str] = None):
cls = super().__new__(mcls, name, bases, dct)
cls._trigger = trigger # type: ignore
cls._binding = binding # type: ignore

if binding is None:
return cls

if binding in mcls._bindings:
raise RuntimeError(
f'cannot register a converter for {binding!r} binding: '
f'another converter for this binding has already been '
f'registered')
_logger.warning("Binding %r already registered. Overwriting to %s", binding, cls)
# raise RuntimeError(
# f'cannot register a converter for {binding!r} binding: '
# f'another converter for this binding has already been '
# f'registered')

mcls._bindings[binding] = cls
if trigger is not None:
Expand Down Expand Up @@ -407,3 +413,24 @@ def encode(cls, obj: Any, *,

def get_binding_registry():
return _ConverterMeta


def register_converter(converter_cls):
"""Public API for third-party packages to register new converters."""
if not hasattr(converter_cls, "_trigger"):
raise RuntimeError("Converter class missing required metadata")

# Use the metaclass registry
binding = getattr(converter_cls, "_binding", None)
trigger = getattr(converter_cls, "_trigger", None)

if binding is None:
raise RuntimeError("Converter has no binding name")

# Reuse the metaclass-level registry
if binding in _ConverterMeta._bindings:
_logger.warning("Binding %r already registered. Overwriting to %s", binding, converter_cls)

_ConverterMeta._bindings[binding] = converter_cls
if trigger:
_ConverterMeta._bindings[trigger] = converter_cls
Loading