localstack-py-avro-schema 3.9.1__py3-none-any.whl → 3.9.2__py3-none-any.whl

{localstack_py_avro_schema-3.9.1.dist-info → localstack_py_avro_schema-3.9.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: localstack-py-avro-schema
-Version: 3.9.1
+Version: 3.9.2
 Summary: Generate Apache Avro schemas for Python types including standard library data-classes and Pydantic data models.
 Author-email: LocalStack Contributors <info@localstack.cloud>, "J.P. Morgan Chase & Co." <open_source@jpmorgan.com>
 License:                                  Apache License

localstack_py_avro_schema-3.9.2.dist-info/RECORD

@@ -0,0 +1,12 @@
+localstack_py_avro_schema-3.9.2.dist-info/licenses/LICENSE,sha256=zE1N4JILDTkSIDtdmqdnKKxKEQh_VdqeoAV2230eNOI,10141
+localstack_py_avro_schema-3.9.2.dist-info/licenses/LICENSE_HEADER.txt,sha256=Nx3RGmYbJKjIKM8Y2yMrCPJgCw4oBt_H62PxDKlAsto,564
+py_avro_schema/__init__.py,sha256=bK6hTw4XJy5bAP4lgIvJR5LHtEiyUWq4GNJ5w-uSEpc,2414
+py_avro_schema/_alias.py,sha256=nCQqtn7IbpjV0ibpJf9aMX9FvwVx2EDC1iKzwjQ7CqI,3412
+py_avro_schema/_schemas.py,sha256=I5otHWPh8tcws3ey4iwsx7c0Zz1VNLmMTabTh43E-7s,46993
+py_avro_schema/_testing.py,sha256=3aSfMbNDDeatl3H7GEUcynxK81HFiF-WCLOZ3FCCLiw,2261
+py_avro_schema/_typing.py,sha256=9kBlPA7C33zZP3nRhCvSJA_0m54uvUo0AQ4wJJmSxMk,3291
+py_avro_schema/py.typed,sha256=HnEDkaznpgfRW07Qfogy4tFLu_4dcQ5YcOsI7pmU5rQ,52
+localstack_py_avro_schema-3.9.2.dist-info/METADATA,sha256=6K-dy4M5Pj2-uoHcRF15vZVRz7pfiibgQcAnysW4YKY,15164
+localstack_py_avro_schema-3.9.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+localstack_py_avro_schema-3.9.2.dist-info/top_level.txt,sha256=0t4oO_5rsdfZGSk8iSzK4TjdyfVz-RE1IZ2TIz6YvI0,15
+localstack_py_avro_schema-3.9.2.dist-info/RECORD,,

py_avro_schema/_alias.py

@@ -5,7 +5,9 @@ This module maintains global state via the _ALIASES registry.
 Decorators will modify this state when applied to classes.
 """
 
+import dataclasses
 from collections import defaultdict
+from typing import Annotated, Type, get_args, get_origin
 
 FQN = str
 """Fully qualified name for a Python type"""
@@ -13,6 +15,20 @@ _ALIASES: dict[FQN, set[FQN]] = defaultdict(set)
 """Maps the FQN of a Python type to a set of aliases"""
 
 
+@dataclasses.dataclass
+class Alias:
+    """Alias for a record field"""
+
+    alias: str
+
+
+@dataclasses.dataclass
+class Aliases:
+    """Aliases for a record field"""
+
+    aliases: list[str]
+
+
 def get_fully_qualified_name(py_type: type) -> str:
     """Returns the fully qualified name for a Python type"""
     module = getattr(py_type, "__module__", None)
@@ -77,3 +93,24 @@ def get_aliases(fqn: str) -> list[str]:
     if aliases := _ALIASES.get(fqn):
         return sorted(aliases)
     return []
+
+
+def get_field_aliases_and_actual_type(py_type: Type) -> tuple[list[str] | None, Type]:
+    """
+    Check if a type contains an alias metadata via `Alias` or `Aliases` as metadata.
+    It returns the eventual aliases and the type.
+    """
+    # py_type is not annotated. It can't have aliases
+    if get_origin(py_type) is not Annotated:
+        return [], py_type
+
+    args = get_args(py_type)
+    actual_type, annotation = args[0], args[1]
+
+    # Annotated type but not an alias. We do nothing.
+    if type(annotation) not in (Alias, Aliases):
+        return [], py_type
+
+    # If the annotated type is an alias, we extract the aliases and return the actual type
+    aliases = annotation.aliases if type(annotation) is Aliases else [annotation.alias]
+    return aliases, actual_type

py_avro_schema/_schemas.py

@@ -50,7 +50,7 @@ import orjson
 import typeguard
 
 import py_avro_schema._typing
-from py_avro_schema._alias import get_aliases
+from py_avro_schema._alias import get_aliases, get_field_aliases_and_actual_type
 
 if TYPE_CHECKING:
     # Pydantic not necessarily required at runtime
@@ -909,6 +909,7 @@ class RecordField:
         py_type: Type,
         name: str,
         namespace: Optional[str],
+        aliases: list[str] | None = None,
         default: Any = dataclasses.MISSING,
         docs: str = "",
         options: Option = Option(0),
@@ -919,12 +920,16 @@ class RecordField:
         :param py_type:   The Python class or type
         :param name:      Field name
         :param namespace: Avro schema namespace
+        :param aliases:   Aliases for the field
         :param default:   Field default value
         :param docs:      Field documentation or description
         :param options:   Schema generation options
         """
+        if aliases is None:
+            aliases = []
         self.py_type = py_type
         self.name = name
+        self.aliases = aliases
         self._namespace = namespace
         self.default = default
         self.docs = docs
@@ -949,6 +954,8 @@ class RecordField:
             "name": self.name,
             "type": self.schema.data(names=names),
         }
+        if self.aliases:
+            field_data["aliases"] = sorted(self.aliases)
         if self.default != dataclasses.MISSING:
             field_data["default"] = self.schema.make_default(self.default)
         if self.docs and Option.NO_DOC not in self.options:
@@ -984,11 +991,13 @@ class DataclassSchema(RecordSchema):
         default = py_field.default
         if callable(py_field.default_factory):  # type: ignore
             default = py_field.default_factory()  # type: ignore
+        aliases, actual_type = get_field_aliases_and_actual_type(py_field.type)  # type: ignore
         field_obj = RecordField(
-            py_type=py_field.type,  # type: ignore
+            py_type=actual_type,  # type: ignore
             name=py_field.name,
             namespace=self.namespace_override,
             default=default,
+            aliases=aliases,
             options=self.options,
         )
 
@@ -1024,11 +1033,13 @@ class PydanticSchema(RecordSchema):
         default = dataclasses.MISSING if py_field.is_required() else py_field.get_default(call_default_factory=True)
         py_type = self._annotation(name)
         record_name = py_field.alias if Option.USE_FIELD_ALIAS in self.options and py_field.alias else name
+        aliases, actual_type = get_field_aliases_and_actual_type(py_type)
         field_obj = RecordField(
-            py_type=py_type,
+            py_type=actual_type,
             name=record_name,
             namespace=self.namespace_override,
             default=default,
+            aliases=aliases,
             docs=py_field.description or "",
             options=self.options,
         )
@@ -1087,11 +1098,13 @@ class PlainClassSchema(RecordSchema):
     def _record_field(self, py_field: inspect.Parameter) -> RecordField:
         """Return an Avro record field object for a given Python instance attribute"""
         default = py_field.default if py_field.default != inspect.Parameter.empty else dataclasses.MISSING
+        aliases, actual_type = get_field_aliases_and_actual_type(py_field.annotation)
         field_obj = RecordField(
-            py_type=py_field.annotation,
+            py_type=actual_type,
             name=py_field.name,
             namespace=self.namespace_override,
             default=default,
+            aliases=aliases,
             options=self.options,
         )
         return field_obj
@@ -1116,15 +1129,17 @@ class TypedDictSchema(RecordSchema):
         """
         super().__init__(py_type, namespace=namespace, options=options)
         py_type = _type_from_annotated(py_type)
-        self.py_fields: dict[str, Type] = get_type_hints(py_type)
+        self.py_fields: dict[str, Type] = get_type_hints(py_type, include_extras=True)
         self.record_fields = [self._record_field(field) for field in self.py_fields.items()]
 
     def _record_field(self, py_field: tuple[str, Type]) -> RecordField:
         """Return an Avro record field object for a given TypedDict field"""
+        aliases, actual_type = get_field_aliases_and_actual_type(py_field[1])
         field_obj = RecordField(
-            py_type=py_field[1],
+            py_type=actual_type,
             name=py_field[0],
             namespace=self.namespace_override,
+            aliases=aliases,
             options=self.options,
         )
         return field_obj

localstack_py_avro_schema-3.9.1.dist-info/RECORD

@@ -1,12 +0,0 @@
-localstack_py_avro_schema-3.9.1.dist-info/licenses/LICENSE,sha256=zE1N4JILDTkSIDtdmqdnKKxKEQh_VdqeoAV2230eNOI,10141
-localstack_py_avro_schema-3.9.1.dist-info/licenses/LICENSE_HEADER.txt,sha256=Nx3RGmYbJKjIKM8Y2yMrCPJgCw4oBt_H62PxDKlAsto,564
-py_avro_schema/__init__.py,sha256=bK6hTw4XJy5bAP4lgIvJR5LHtEiyUWq4GNJ5w-uSEpc,2414
-py_avro_schema/_alias.py,sha256=B0wfiva1ErVna1rpTCjhuvYHhoYOz_-YgcW8C2TrIOo,2360
-py_avro_schema/_schemas.py,sha256=uyBheFP-0o7RBBBJVZg2FNxErwoydlgojYc88B51kDg,46237
-py_avro_schema/_testing.py,sha256=3aSfMbNDDeatl3H7GEUcynxK81HFiF-WCLOZ3FCCLiw,2261
-py_avro_schema/_typing.py,sha256=9kBlPA7C33zZP3nRhCvSJA_0m54uvUo0AQ4wJJmSxMk,3291
-py_avro_schema/py.typed,sha256=HnEDkaznpgfRW07Qfogy4tFLu_4dcQ5YcOsI7pmU5rQ,52
-localstack_py_avro_schema-3.9.1.dist-info/METADATA,sha256=DcY8xlpg6j-rl_gcSRsoVfdAzmI_S491g83ZBcCyYOo,15164
-localstack_py_avro_schema-3.9.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-localstack_py_avro_schema-3.9.1.dist-info/top_level.txt,sha256=0t4oO_5rsdfZGSk8iSzK4TjdyfVz-RE1IZ2TIz6YvI0,15
-localstack_py_avro_schema-3.9.1.dist-info/RECORD,,