pydantic-avro 0.8.1__tar.gz → 0.9.0__tar.gz

{pydantic_avro-0.8.1 → pydantic_avro-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pydantic-avro
-Version: 0.8.1
+Version: 0.9.0
 Summary: Converting pydantic classes to avro schemas
 Home-page: https://github.com/godatadriven/pydantic-avro
 License: MIT

{pydantic_avro-0.8.1 → pydantic_avro-0.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pydantic-avro"
-version = "0.8.1"
+version = "0.9.0"
 description = "Converting pydantic classes to avro schemas"
 authors = ["Peter van 't Hof' <peter.vanthof@godatadriven.com>"]
 

{pydantic_avro-0.8.1 → pydantic_avro-0.9.0}/setup.py

@@ -18,7 +18,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'pydantic-avro',
-    'version': '0.8.1',
+    'version': '0.9.0',
     'description': 'Converting pydantic classes to avro schemas',
     'long_description': '[![Python package](https://github.com/godatadriven/pydantic-avro/actions/workflows/python-package.yml/badge.svg)](https://github.com/godatadriven/pydantic-avro/actions/workflows/python-package.yml)\n[![codecov](https://codecov.io/gh/godatadriven/pydantic-avro/branch/main/graph/badge.svg?token=5L08GOERAW)](https://codecov.io/gh/godatadriven/pydantic-avro)\n[![PyPI version](https://badge.fury.io/py/pydantic-avro.svg)](https://badge.fury.io/py/pydantic-avro)\n[![CodeQL](https://github.com/godatadriven/pydantic-avro/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/godatadriven/pydantic-avro/actions/workflows/codeql-analysis.yml)\n\n# pydantic-avro\n\nThis library can convert a pydantic class to a avro schema or generate python code from a avro schema.\n\n### Install\n\n```bash\npip install pydantic-avro\n```\n\n### Pydantic class to avro schema\n\n```python\nimport json\nfrom typing import Optional\n\nfrom pydantic_avro.base import AvroBase\n\n\nclass TestModel(AvroBase):\n    key1: str\n    key2: int\n    key2: Optional[str]\n\n\nschema_dict: dict = TestModel.avro_schema()\nprint(json.dumps(schema_dict))\n\n```\n\n### Avro schema to pydantic\n\n```shell\n# Print to stdout\npydantic-avro avro_to_pydantic --asvc /path/to/schema.asvc\n\n# Save it to a file\npydantic-avro avro_to_pydantic --asvc /path/to/schema.asvc --output /path/to/output.py\n```\n\n### Specify expected Avro type\n\n```python\nfrom datetime import datetime\nfrom pydantic import Field\nfrom pydantic_avro.base import AvroBase \n\nclass ExampleModel(AvroBase):\n    field1: int = Field(..., avro_type="long")  # Explicitly set Avro type to "long"\n    field2: datetime = Field(..., avro_type="timestamp-millis")  # Explicitly set Avro type to "timestamp-millis"\n```\n\n### Install for developers\n\n###### Install package\n\n- Requirement: Poetry 1.*\n\n```shell\npoetry install\n```\n\n###### Run unit tests\n```shell\npytest\ncoverage run -m pytest  # with coverage\n# or (depends on your local env) \npoetry run pytest\npoetry run coverage run -m pytest  # with coverage\n```\n\n##### Run linting\n\nThe linting is checked in the github workflow. To fix and review issues run this:\n```shell\nblack .   # Auto fix all issues\nisort .   # Auto fix all issues\npflake .  # Only display issues, fixing is manual\n```\n',
     'author': "Peter van 't Hof'",

{pydantic_avro-0.8.1 → pydantic_avro-0.9.0}/src/pydantic_avro/to_avro/types.py

@@ -61,6 +61,8 @@ AVRO_TYPE_MAPPING = {
     },
 }
 
+PRIMITVE_TYPES = ["int", "long", "float", "double", "boolean", "null"]
+
 
 def get_definition(ref: str, schema: dict):
     """Reading definition of base schema for nested structs"""
@@ -133,6 +135,9 @@ class AvroTypeConverter:
         at = field_props.get("avro_type")
         if "allOf" in field_props and len(field_props["allOf"]) == 1:
             r = field_props["allOf"][0]["$ref"]
+        if ("prefixItems" in field_props or ("minItems" in field_props and "maxItems" in field_props)) and t == "array":
+            t = "tuple"
+
         u = field_props.get("anyOf")
 
         if u is not None:
@@ -162,6 +167,8 @@ class AvroTypeConverter:
             avro_type_dict["type"] = "boolean"
         elif t == "null":
             avro_type_dict["type"] = "null"
+        elif t == "tuple":
+            return self._tuple_to_avro(field_props, avro_type_dict)
         else:
             raise NotImplementedError(
                 f"Type '{t}' not support yet, "
@@ -216,7 +223,10 @@ class AvroTypeConverter:
     def _object_to_avro(self, field_props: dict) -> dict:
         """Returns a type of an object field"""
         a = field_props.get("additionalProperties")
-        value_type = "string" if a is None else self._get_avro_type_dict(a)["type"]
+        if not a or isinstance(a, bool):
+            value_type = "string"
+        else:
+            value_type = self._get_avro_type_dict(a)["type"]
         return {"type": "map", "values": value_type}
 
     def _union_to_avro(self, field_props: list, avro_type_dict: dict) -> dict:
@@ -227,23 +237,43 @@ class AvroTypeConverter:
             avro_type_dict["type"].append(t["type"])
         return avro_type_dict
 
+    def _tuple_to_avro(self, field_props: dict, avro_type_dict: dict) -> dict:
+        """Returns a type of a tuple field"""
+        prefix_items = field_props.get("prefixItems")
+        if not prefix_items:
+            # Pydantic v1 there is no prefixItems, but minItems and maxItems and items is a list.
+            prefix_items = field_props.get("items")
+            if not prefix_items:
+                raise ValueError(f"Tuple Field '{field_props}' does not have any items .")
+        possible_types = []
+        for prefix_item in prefix_items:
+            item_type = self._get_avro_type(prefix_item, avro_type_dict).get("type")
+            if not item_type:
+                raise ValueError(f"Field '{avro_type_dict}' does not have a defined type.")
+            if isinstance(item_type, list):
+                possible_types.extend([x for x in item_type if x not in possible_types])
+            elif item_type not in possible_types:
+                possible_types.append(item_type)
+        avro_type_dict["type"] = {"type": "array", "items": possible_types}
+        return avro_type_dict
+
     def _array_to_avro(self, field_props: dict, avro_type_dict: dict) -> dict:
         """Returns a type of an array field"""
-        items = field_props["items"]
+        items = field_props.get("items")
+        # In pydantic v1. items is a list, we need to handle this case first
+        # E.g. [{'type': 'number'}, {'type': 'number'}]}
+        if isinstance(items, list):
+            if not len(items):
+                raise ValueError(f"Field '{field_props}' does not have valid items.")
+            items = items[0]
+        if not isinstance(items, dict):
+            raise ValueError(f"Field '{field_props}' does not have valid items.")
         tn = self._get_avro_type_dict(items)
         # If items in array are an object:
         if "$ref" in items:
             tn = tn["type"]
         # If items in array are a logicalType
-        if (
-            isinstance(tn, dict)
-            and isinstance(tn.get("type", {}), dict)
-            and tn.get("type", {}).get("logicalType") is not None
-        ):
+        if isinstance(tn, dict) and isinstance(tn.get("type", None), (dict, list)):
             tn = tn["type"]
-        # If items in array are an array, the structure must be corrected
-        if isinstance(tn, dict) and isinstance(tn.get("type", {}), dict) and tn.get("type", {}).get("type") == "array":
-            items = tn["type"]["items"]
-            tn = {"type": "array", "items": items}
         avro_type_dict["type"] = {"type": "array", "items": tn}
         return avro_type_dict