localstack-py-avro-schema 3.9.7__tar.gz → 3.9.8__tar.gz

{localstack_py_avro_schema-3.9.7 → localstack_py_avro_schema-3.9.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: localstack-py-avro-schema
-Version: 3.9.7
+Version: 3.9.8
 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.7 → localstack_py_avro_schema-3.9.8}/src/localstack_py_avro_schema.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: localstack-py-avro-schema
-Version: 3.9.7
+Version: 3.9.8
 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.7 → localstack_py_avro_schema-3.9.8}/src/localstack_py_avro_schema.egg-info/SOURCES.txt

@@ -34,4 +34,6 @@ tests/test_plain_class.py
 tests/test_primitives.py
 tests/test_pydantic.py
 tests/test_typed_dict.py
-tests/test_typing.py
+tests/test_typing.py
+tests/models/__init__.py
+tests/models/forward.py

{localstack_py_avro_schema-3.9.7 → localstack_py_avro_schema-3.9.8}/src/py_avro_schema/_schemas.py

@@ -33,6 +33,7 @@ from typing import (
     Annotated,
     Any,
     Dict,
+    Final,
     ForwardRef,
     List,
     Literal,
@@ -378,6 +379,31 @@ class LiteralSchema(Schema):
         return self.literal_value_schema.data(names=names)
 
 
+@register_schema
+class FinalSchema(Schema):
+    """An Avro schema for Python ``typing.Final``"""
+
+    def __init__(self, py_type: Type, namespace: Optional[str] = None, options: Option = Option(0)):
+        """An Avro schema for Python ``typing.Final``"""
+        super().__init__(py_type, namespace, options)
+        py_type = _type_from_annotated(py_type)
+        try:
+            real_type = get_args(py_type)[0]
+        except IndexError:
+            raise TypeError("Can't generate Avro schema from Python typing.Final without a type parameter")
+        self.real_schema = _schema_obj(real_type, namespace=namespace, options=options)
+
+    def data(self, names: NamesType) -> JSONType:
+        """Return the schema data"""
+        return self.real_schema.data(names=names)
+
+    @classmethod
+    def handles_type(cls, py_type: Type) -> bool:
+        """Whether this schema class can represent a given Python class"""
+        py_type = _type_from_annotated(py_type)
+        return get_origin(py_type) is Final or py_type is Final
+
+
 @register_schema
 class DictAsJSONSchema(Schema):
     """An Avro string schema representing a Python Dict[str, Any] or List[Dict[str, Any]] assuming JSON serialization"""
@@ -1156,8 +1182,13 @@ class PlainClassSchema(RecordSchema):
         super().__init__(py_type, namespace=namespace, options=options)
         py_type = _type_from_annotated(py_type)
 
+        # Try to get resolved type hints, but fall back to raw annotations if there are unresolved forward refs
+        try:
+            type_hints = get_type_hints(py_type, include_extras=True)
+        except NameError:
+            type_hints = py_type.__annotations__
         self.py_fields: list[tuple[str, type]] = []
-        for k, v in py_type.__annotations__.items():
+        for k, v in type_hints.items():
             self.py_fields.append((k, v))
         # We store __init__ parameters with default values. They can be used as defaults for the record.
         self.signature_fields = {

localstack_py_avro_schema-3.9.8/tests/models/forward.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+Name = str
+
+
+class PyClass:
+    """For testing imports with future annotations"""
+
+    name: Name

{localstack_py_avro_schema-3.9.7 → localstack_py_avro_schema-3.9.8}/tests/test_plain_class.py

@@ -10,7 +10,7 @@
 # specific language governing permissions and limitations under the License.
 
 import re
-from typing import Annotated
+from typing import Annotated, Final
 
 import pytest
 
@@ -143,3 +143,39 @@ def test_opaque_field():
 
     expected = {"fields": [{"name": "details", "type": "string"}], "name": "PyType", "type": "record"}
     assert_schema(PyType, expected)
+
+
+def test_type_aliases():
+    Name = str
+
+    class PyClass:
+        name: Name
+
+    expected = {"fields": [{"name": "name", "type": "string"}], "name": "PyClass", "type": "record"}
+    assert_schema(PyClass, expected)
+
+
+def test_type_aliases_future():
+    from tests.models.forward import PyClass
+
+    expected = {"fields": [{"name": "name", "type": "string"}], "name": "PyClass", "type": "record"}
+    assert_schema(PyClass, expected)
+
+
+def test_typing_final():
+
+    class PyType:
+        var: Final[str]
+        field: Final[dict[str, int]]
+
+        def __init__(self):
+            self.var = "Hello World"
+            self.field = {"John": 123}
+
+    expected = {
+        "fields": [{"name": "var", "type": "string"}, {"name": "field", "type": {"type": "map", "values": "long"}}],
+        "name": "PyType",
+        "type": "record",
+    }
+
+    assert_schema(PyType, expected)