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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pydantic-avro
-Version: 0.7.3
+Version: 0.8.1
 Summary: Converting pydantic classes to avro schemas
 Home-page: https://github.com/godatadriven/pydantic-avro
 License: MIT
@@ -62,6 +62,17 @@ pydantic-avro avro_to_pydantic --asvc /path/to/schema.asvc
 pydantic-avro avro_to_pydantic --asvc /path/to/schema.asvc --output /path/to/output.py
 ```
 
+### Specify expected Avro type
+
+```python
+from datetime import datetime
+from pydantic import Field
+from pydantic_avro.base import AvroBase 
+
+class ExampleModel(AvroBase):
+    field1: int = Field(..., avro_type="long")  # Explicitly set Avro type to "long"
+    field2: datetime = Field(..., avro_type="timestamp-millis")  # Explicitly set Avro type to "timestamp-millis"
+```
 
 ### Install for developers
 

{pydantic_avro-0.7.3 → pydantic_avro-0.8.1}/README.md

@@ -43,6 +43,17 @@ pydantic-avro avro_to_pydantic --asvc /path/to/schema.asvc
 pydantic-avro avro_to_pydantic --asvc /path/to/schema.asvc --output /path/to/output.py
 ```
 
+### Specify expected Avro type
+
+```python
+from datetime import datetime
+from pydantic import Field
+from pydantic_avro.base import AvroBase 
+
+class ExampleModel(AvroBase):
+    field1: int = Field(..., avro_type="long")  # Explicitly set Avro type to "long"
+    field2: datetime = Field(..., avro_type="timestamp-millis")  # Explicitly set Avro type to "timestamp-millis"
+```
 
 ### Install for developers
 

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pydantic-avro"
-version = "0.7.3"
+version = "0.8.1"
 description = "Converting pydantic classes to avro schemas"
 authors = ["Peter van 't Hof' <peter.vanthof@godatadriven.com>"]
 
@@ -9,7 +9,6 @@ readme = "README.md"
 license = "MIT"
 homepage = "https://github.com/godatadriven/pydantic-avro"
 repository = "https://github.com/godatadriven/pydantic-avro"
-include = ["LICENSE"]
 
 
 packages = [{ include = "pydantic_avro", from = "src" }]
@@ -24,10 +23,10 @@ pytest = "^8.3.5"
 pytest-mock = "^3.10.0"
 pyproject-flake8 = "^7.0.0"
 isort = "^5.10.0"
-black = "24.4.2"
+black = "24.8.0"
 pytest-cov = "^5.0.0"
 mypy = "^1.1.1"
-avro = "^1.11.3"
+avro = "^1.12.0"
 fastavro = "^1.8.1"
 
 [tool.poetry.scripts]
@@ -63,6 +62,7 @@ line_length = 120
 [tool.mypy]
 files = "src/"
 python_version = "3.9"
+ignore_missing_imports = "true"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

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

@@ -18,9 +18,9 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'pydantic-avro',
-    'version': '0.7.3',
+    'version': '0.8.1',
     '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\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',
+    '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'",
     'author_email': 'peter.vanthof@godatadriven.com',
     'maintainer': 'None',

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

@@ -22,6 +22,45 @@ STRING_TYPE_MAPPING = {
     "binary": "bytes",
 }
 
+AVRO_TYPE_MAPPING = {
+    "timestamp-millis": {
+        "type": "long",
+        "logicalType": "timestamp-millis",
+    },
+    "timestamp-micros": {
+        "type": "long",
+        "logicalType": "timestamp-micros",
+    },
+    "time-millis": {
+        "type": "int",
+        "logicalType": "time-millis",
+    },
+    "time-micros": {
+        "type": "long",
+        "logicalType": "time-micros",
+    },
+    "decimal": {
+        "type": "bytes",
+        "logicalType": "decimal",
+    },
+    "uuid": {
+        "type": "string",
+        "logicalType": "uuid",
+    },
+    "int": "int",
+    "long": "long",
+    "float": "float",
+    "double": "double",
+    "boolean": "boolean",
+    "bytes": "bytes",
+    "string": "string",
+    "null": "null",
+    "date": {
+        "type": "int",
+        "logicalType": "date",
+    },
+}
+
 
 def get_definition(ref: str, schema: dict):
     """Reading definition of base schema for nested structs"""
@@ -91,6 +130,7 @@ class AvroTypeConverter:
         t = field_props.get("type")
         f = field_props.get("format")
         r = field_props.get("$ref")
+        at = field_props.get("avro_type")
         if "allOf" in field_props and len(field_props["allOf"]) == 1:
             r = field_props["allOf"][0]["$ref"]
         u = field_props.get("anyOf")
@@ -101,6 +141,13 @@ class AvroTypeConverter:
             return self._handle_references(r, avro_type_dict)
         elif t is None:
             raise ValueError(f"Field '{field_props}' does not have a defined type.")
+        elif at is not None:
+            if not isinstance(at, str) or at not in AVRO_TYPE_MAPPING:
+                raise ValueError(
+                    f"Field '{field_props}' does not have a supported avro_type. Type should be one of "
+                    f" {AVRO_TYPE_MAPPING.keys()}"
+                )
+            avro_type_dict["type"] = AVRO_TYPE_MAPPING[at]
         elif t == "array":
             return self._array_to_avro(field_props, avro_type_dict)
         elif t == "string":