pydantic-avro 0.9.1__tar.gz → 0.9.3__tar.gz

{pydantic_avro-0.9.1 → pydantic_avro-0.9.3}/PKG-INFO

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

{pydantic_avro-0.9.1 → pydantic_avro-0.9.3}/pyproject.toml

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

{pydantic_avro-0.9.1 → pydantic_avro-0.9.3}/setup.py

@@ -18,7 +18,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'pydantic-avro',
-    'version': '0.9.1',
+    'version': '0.9.3',
     '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.9.1 → pydantic_avro-0.9.3}/src/pydantic_avro/from_avro/types.py

@@ -132,7 +132,7 @@ def generate_field_string(field: dict) -> str:
 
 def get_pydantic_type(t: Union[str, dict]) -> str:
     """Get the Pydantic type for a given Avro type"""
-    if isinstance(t, str):
+    if isinstance(t, str) or isinstance(t, list):
         t = {"type": t}
 
     if isinstance(t.get("type"), str):

{pydantic_avro-0.9.1 → pydantic_avro-0.9.3}/src/pydantic_avro/to_avro/base.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Literal, Optional
 
 from pydantic import BaseModel
 
@@ -10,14 +10,30 @@ class AvroBase(BaseModel):
     """This class provides functionality to convert a pydantic model to an Avro schema."""
 
     @classmethod
-    def avro_schema(cls, by_alias: bool = True, namespace: Optional[str] = None) -> dict:
+    def avro_schema(
+        cls,
+        by_alias: bool = True,
+        namespace: Optional[str] = None,
+        mode: Literal["validation", "serialization"] = "serialization",
+    ) -> dict:
         """Returns the avro schema for the pydantic class
 
         :param by_alias: generate the schemas using the aliases defined, if any
         :param namespace: Provide an optional namespace string to use in schema generation
+        :param mode: The mode for generating the schema. Use 'validation' for input validation
+                     or 'serialization' for output serialization. Defaults to 'serialization'.
+                     Only applicable for Pydantic v2.
         :return: dict with the Avro Schema for the model
         """
-        schema = cls.model_json_schema(by_alias=by_alias) if PYDANTIC_V2 else cls.schema(by_alias=by_alias)
+        if PYDANTIC_V2:
+            schema = cls.model_json_schema(by_alias=by_alias, mode=mode)
+        else:
+            if mode != "serialization":
+                raise ValueError(
+                    f"The 'mode' parameter is only supported in Pydantic v2. "
+                    f"Pydantic v1 does not support different schema modes."
+                )
+            schema = cls.schema(by_alias=by_alias)
 
         if namespace is None:
             # Default namespace will be based on title