pyrmute 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

pyrmute/__init__.py

@@ -1,9 +1,8 @@
-"""pyrmute - versioned Pydantic models and schemas with migrations.
-
-A package for managing versioned Pydantic models with automatic migrations
-and schema management.
-"""
+"""pyrmute - versioned Pydantic models and schemas with migrations."""
 
+from ._migration_manager import MigrationManager
+from ._registry import Registry
+from ._schema_manager import SchemaManager
 from ._version import __version__
 from .exceptions import (
     InvalidVersionError,
@@ -21,27 +20,28 @@ from .model_manager import ModelManager
 from .model_version import ModelVersion
 from .types import (
     JsonSchema,
-    JsonValue,
-    MigrationData,
     MigrationFunc,
-    ModelMetadata,
+    ModelData,
+    NestedModelInfo,
 )
 
 __all__ = [
     "InvalidVersionError",
     "JsonSchema",
-    "JsonValue",
-    "MigrationData",
     "MigrationError",
     "MigrationFunc",
+    "MigrationManager",
     "MigrationTestCase",
     "MigrationTestResult",
     "MigrationTestResults",
+    "ModelData",
     "ModelDiff",
     "ModelManager",
-    "ModelMetadata",
     "ModelNotFoundError",
     "ModelVersion",
+    "NestedModelInfo",
+    "Registry",
+    "SchemaManager",
     "VersionedModelError",
     "__version__",
 ]

pyrmute/_migration_manager.py

@@ -11,7 +11,7 @@ from pydantic_core import PydanticUndefined
 from ._registry import Registry
 from .exceptions import MigrationError, ModelNotFoundError
 from .model_version import ModelVersion
-from .types import MigrationData, MigrationFunc, ModelName
+from .types import MigrationFunc, ModelData, ModelName
 
 
 class MigrationManager:
@@ -73,11 +73,11 @@ class MigrationManager:
 
     def migrate(
         self: Self,
-        data: MigrationData,
+        data: ModelData,
         name: ModelName,
         from_version: str | ModelVersion,
         to_version: str | ModelVersion,
-    ) -> MigrationData:
+    ) -> ModelData:
         """Migrate data from one version to another.
 
         Args:
@@ -224,11 +224,11 @@ class MigrationManager:
 
     def _auto_migrate(
         self: Self,
-        data: MigrationData,
+        data: ModelData,
         name: ModelName,
         from_ver: ModelVersion,
         to_ver: ModelVersion,
-    ) -> MigrationData:
+    ) -> ModelData:
         """Automatically migrate data when no explicit migration exists.
 
         This method handles nested Pydantic models recursively, migrating them to their
@@ -249,7 +249,7 @@ class MigrationManager:
         from_fields = from_model.model_fields
         to_fields = to_model.model_fields
 
-        result: MigrationData = {}
+        result: ModelData = {}
 
         for field_name, to_field_info in to_fields.items():
             # Field exists in data, migrate it
@@ -313,7 +313,7 @@ class MigrationManager:
 
     def _extract_nested_model_info(
         self: Self,
-        value: MigrationData,
+        value: ModelData,
         from_field: FieldInfo | None,
         to_field: FieldInfo,
     ) -> tuple[ModelName, ModelVersion, ModelVersion] | None:

pyrmute/_schema_manager.py

@@ -16,6 +16,7 @@ from .types import (
     JsonValue,
     ModelMetadata,
     ModelName,
+    NestedModelInfo,
 )
 
 
@@ -285,7 +286,7 @@ class SchemaManager:
         self: Self,
         name: ModelName,
         version: str | ModelVersion,
-    ) -> list[ModelMetadata]:
+    ) -> list[NestedModelInfo]:
         """Get all nested models referenced by a model.
 
         Args:
@@ -293,19 +294,28 @@ class SchemaManager:
             version: Semantic version.
 
         Returns:
-            List of (model_name, model_version) tuples for nested models.
+            List of NestedModelInfo.
         """
         ver = ModelVersion.parse(version) if isinstance(version, str) else version
         model = self.registry.get_model(name, ver)
 
-        nested: list[ModelMetadata] = []
+        nested: list[NestedModelInfo] = []
 
         for field_info in model.model_fields.values():
             model_type = self._get_model_type_from_field(field_info)
-            if model_type:
-                model_info = self.registry.get_model_info(model_type)
-                if model_info and model_info not in nested:
-                    nested.append(model_info)
+            if not model_type:
+                continue
+
+            model_info = self.registry.get_model_info(model_type)
+
+            if not model_info:
+                continue
+
+            name_, version_ = model_info
+            nested_model_info = NestedModelInfo(name=name_, version=version_)
+
+            if nested_model_info not in nested:
+                nested.append(nested_model_info)
 
         return nested
 

pyrmute/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.2.0'
-__version_tuple__ = version_tuple = (0, 2, 0)
+__version__ = version = '0.3.0'
+__version_tuple__ = version_tuple = (0, 3, 0)
 
 __commit_id__ = commit_id = None

pyrmute/migration_testing.py

@@ -4,7 +4,7 @@ from collections.abc import Iterator
 from dataclasses import dataclass
 from typing import Self
 
-from .types import MigrationData
+from .types import ModelData
 
 
 @dataclass
@@ -28,8 +28,8 @@ class MigrationTestCase:
         ... )
     """
 
-    source: MigrationData
-    target: MigrationData | None = None
+    source: ModelData
+    target: ModelData | None = None
     description: str = ""
 
 
@@ -55,7 +55,7 @@ class MigrationTestResult:
     """
 
     test_case: MigrationTestCase
-    actual: MigrationData
+    actual: ModelData
     passed: bool
     error: str | None = None
 

pyrmute/model_manager.py

@@ -22,9 +22,9 @@ from .types import (
     DecoratedBaseModel,
     JsonSchema,
     JsonSchemaGenerator,
-    MigrationData,
     MigrationFunc,
-    ModelMetadata,
+    ModelData,
+    NestedModelInfo,
 )
 
 
@@ -55,7 +55,7 @@ class ModelManager:
         >>>
         >>> # Define migration between versions
         >>> @manager.migration("User", "1.0.0", "2.0.0")
-        ... def migrate(data: MigrationData) -> MigrationData:
+        ... def migrate(data: ModelData) -> ModelData:
         ...     return {**data, "email": "unknown@example.com"}
         >>>
         >>> # Migrate legacy data
@@ -91,9 +91,9 @@ class ModelManager:
 
     def __init__(self: Self) -> None:
         """Initialize the versioned model manager."""
-        self.registry = Registry()
-        self.migration_manager = MigrationManager(self.registry)
-        self.schema_manager = SchemaManager(self.registry)
+        self._registry = Registry()
+        self._migration_manager = MigrationManager(self._registry)
+        self._schema_manager = SchemaManager(self._registry)
 
     def model(
         self: Self,
@@ -129,7 +129,7 @@ class ModelManager:
             ... class CityV1(BaseModel):
             ...     city: City
         """
-        return self.registry.register(
+        return self._registry.register(
             name, version, schema_generator, enable_ref, backward_compatible
         )
 
@@ -149,11 +149,11 @@ class ModelManager:
         Returns:
             Decorator function for migration function.
         """
-        return self.migration_manager.register_migration(name, from_version, to_version)
+        return self._migration_manager.register_migration(
+            name, from_version, to_version
+        )
 
-    def get(
-        self: Self, name: str, version: str | ModelVersion | None = None
-    ) -> type[BaseModel]:
+    def get(self: Self, name: str, version: str | ModelVersion) -> type[BaseModel]:
         """Get a model by name and version.
 
         Args:
@@ -163,9 +163,18 @@ class ModelManager:
         Returns:
             Model class.
         """
-        if version is None:
-            return self.registry.get_latest(name)
-        return self.registry.get_model(name, version)
+        return self._registry.get_model(name, version)
+
+    def get_latest(self: Self, name: str) -> type[BaseModel]:
+        """Get the latest version of a model by name.
+
+        Args:
+            name: Name of the model.
+
+        Returns:
+            Model class.
+        """
+        return self._registry.get_latest(name)
 
     def has_migration_path(
         self: Self,
@@ -200,14 +209,14 @@ class ModelManager:
             else to_version
         )
         try:
-            self.migration_manager.validate_migration_path(name, from_ver, to_ver)
+            self._migration_manager.validate_migration_path(name, from_ver, to_ver)
             return True
         except (KeyError, ModelNotFoundError, MigrationError):
             return False
 
     def validate_data(
         self: Self,
-        data: MigrationData,
+        data: ModelData,
         name: str,
         version: str | ModelVersion,
     ) -> bool:
@@ -241,7 +250,7 @@ class ModelManager:
 
     def migrate(
         self: Self,
-        data: MigrationData,
+        data: ModelData,
         name: str,
         from_version: str | ModelVersion,
         to_version: str | ModelVersion,
@@ -263,11 +272,11 @@ class ModelManager:
 
     def migrate_data(
         self: Self,
-        data: MigrationData,
+        data: ModelData,
         name: str,
         from_version: str | ModelVersion,
         to_version: str | ModelVersion,
-    ) -> MigrationData:
+    ) -> ModelData:
         """Migrate data between versions.
 
         Args:
@@ -279,11 +288,11 @@ class ModelManager:
         Returns:
             Raw migrated dictionary.
         """
-        return self.migration_manager.migrate(data, name, from_version, to_version)
+        return self._migration_manager.migrate(data, name, from_version, to_version)
 
     def migrate_batch(  # noqa: PLR0913
         self: Self,
-        data_list: Iterable[MigrationData],
+        data_list: Iterable[ModelData],
         name: str,
         from_version: str | ModelVersion,
         to_version: str | ModelVersion,
@@ -341,14 +350,14 @@ class ModelManager:
 
     def migrate_batch_data(  # noqa: PLR0913
         self: Self,
-        data_list: Iterable[MigrationData],
+        data_list: Iterable[ModelData],
         name: str,
         from_version: str | ModelVersion,
         to_version: str | ModelVersion,
         parallel: bool = False,
         max_workers: int | None = None,
         use_processes: bool = False,
-    ) -> list[MigrationData]:
+    ) -> list[ModelData]:
         """Migrate multiple data items between versions, returning raw dictionaries.
 
         Args:
@@ -393,7 +402,7 @@ class ModelManager:
 
     def migrate_batch_streaming(
         self: Self,
-        data_list: Iterable[MigrationData],
+        data_list: Iterable[ModelData],
         name: str,
         from_version: str | ModelVersion,
         to_version: str | ModelVersion,
@@ -439,12 +448,12 @@ class ModelManager:
 
     def migrate_batch_data_streaming(
         self: Self,
-        data_list: Iterable[MigrationData],
+        data_list: Iterable[ModelData],
         name: str,
         from_version: str | ModelVersion,
         to_version: str | ModelVersion,
         chunk_size: int = 100,
-    ) -> Iterable[MigrationData]:
+    ) -> Iterable[ModelData]:
         """Migrate data in chunks, yielding raw dictionaries as they complete.
 
         Useful for large datasets where you want to start processing results before all
@@ -548,7 +557,7 @@ class ModelManager:
         Returns:
             JSON schema dictionary.
         """
-        return self.schema_manager.get_schema(name, version, **kwargs)
+        return self._schema_manager.get_schema(name, version, **kwargs)
 
     def list_models(self: Self) -> list[str]:
         """Get list of all registered models.
@@ -556,7 +565,7 @@ class ModelManager:
         Returns:
             List of model names.
         """
-        return self.registry.list_models()
+        return self._registry.list_models()
 
     def list_versions(self: Self, name: str) -> list[ModelVersion]:
         """Get all versions for a model.
@@ -567,7 +576,7 @@ class ModelManager:
         Returns:
             Sorted list of versions.
         """
-        return self.registry.get_versions(name)
+        return self._registry.get_versions(name)
 
     def dump_schemas(
         self: Self,
@@ -582,7 +591,8 @@ class ModelManager:
             output_dir: Directory path for output.
             indent: JSON indentation level.
             separate_definitions: If True, create separate schema files for nested
-                models and use $ref to reference them.
+                models and use $ref to reference them. Only applies to models with
+                'enable_ref=True'.
             ref_template: Template for $ref URLs when separate_definitions=True.
                 Defaults to relative file references if not provided.
 
@@ -600,46 +610,15 @@ class ModelManager:
             ...     ref_template="https://example.com/schemas/{model}_v{version}.json"
             ... )
         """
-        self.schema_manager.dump_schemas(
+        self._schema_manager.dump_schemas(
             output_dir, indent, separate_definitions, ref_template
         )
 
-    def dump_schemas_with_refs(
-        self: Self,
-        output_dir: str | Path,
-        ref_template: str | None = None,
-        indent: int = 2,
-    ) -> None:
-        """Export schemas with separate files for nested models.
-
-        This is a convenience method that calls dump_schemas with
-        separate_definitions=True.
-
-        Args:
-            output_dir: Directory path for output.
-            ref_template: Template for $ref URLs. Supports {model} and {version}
-                placeholders. Defaults to relative file refs.
-            indent: JSON indentation level.
-
-        Example:
-            >>> # Relative file references (default)
-            >>> manager.dump_schemas_with_refs("schemas/")
-            >>>
-            >>> # Absolute URL references
-            >>> manager.dump_schemas_with_refs(
-            ...     "schemas/",
-            ...     ref_template="https://example.com/schemas/{model}_v{version}.json"
-            ... )
-        """
-        self.schema_manager.dump_schemas(
-            output_dir, indent, separate_definitions=True, ref_template=ref_template
-        )
-
     def get_nested_models(
         self: Self,
         name: str,
         version: str | ModelVersion,
-    ) -> list[ModelMetadata]:
+    ) -> list[NestedModelInfo]:
         """Get all nested models used by a model.
 
         Args:
@@ -647,16 +626,16 @@ class ModelManager:
             version: Semantic version.
 
         Returns:
-            List of (model_name, version) tuples for nested models.
+            List of NestedModelInfo.
         """
-        return self.schema_manager.get_nested_models(name, version)
+        return self._schema_manager.get_nested_models(name, version)
 
     def test_migration(
         self: Self,
         name: str,
         from_version: str | ModelVersion,
         to_version: str | ModelVersion,
-        test_cases: list[tuple[MigrationData, MigrationData] | MigrationTestCase],
+        test_cases: list[tuple[ModelData, ModelData] | MigrationTestCase],
     ) -> MigrationTestResults:
         """Test a migration with multiple test cases.
 

pyrmute/types.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 from collections.abc import Callable
+from dataclasses import dataclass
 from typing import Any, TypeAlias, TypeVar
 
 from pydantic import BaseModel
@@ -19,13 +20,19 @@ JsonSchemaDefinitions: TypeAlias = dict[str, JsonValue]
 JsonSchemaGenerator: TypeAlias = Callable[[type[BaseModel]], JsonSchema]
 SchemaGenerators: TypeAlias = dict[ModelVersion, JsonSchemaGenerator]
 
-MigrationData: TypeAlias = dict[str, Any]
-MigrationFunc: TypeAlias = Callable[[MigrationData], MigrationData]
-
-
+ModelData: TypeAlias = dict[str, Any]
+MigrationFunc: TypeAlias = Callable[[ModelData], ModelData]
 MigrationKey: TypeAlias = tuple[ModelVersion, ModelVersion]
 MigrationMap: TypeAlias = dict[MigrationKey, MigrationFunc]
 
 ModelName: TypeAlias = str
 ModelMetadata: TypeAlias = tuple[ModelName, ModelVersion]
 VersionedModels: TypeAlias = dict[ModelVersion, type[BaseModel]]
+
+
+@dataclass
+class NestedModelInfo:
+    """Contains information about nested models."""
+
+    name: str
+    version: ModelVersion

{pyrmute-0.2.0.dist-info → pyrmute-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyrmute
-Version: 0.2.0
+Version: 0.3.0
 Summary: Pydantic model migrations and schemas
 Author-email: Matt Ferrera <mattferrera@gmail.com>
 License: MIT
@@ -14,6 +14,7 @@ Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Natural Language :: English
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
@@ -70,7 +71,7 @@ pip install pyrmute
 
 ```python
 from pydantic import BaseModel
-from pyrmute import ModelManager, MigrationData
+from pyrmute import ModelManager, ModelData
 
 manager = ModelManager()
 
@@ -101,7 +102,7 @@ class UserV3(BaseModel):
 
 # Define how to migrate between versions
 @manager.migration("User", "1.0.0", "2.0.0")
-def split_name(data: MigrationData) -> MigrationData:
+def split_name(data: ModelData) -> ModelData:
     parts = data["name"].split(" ", 1)
     return {
         "first_name": parts[0],
@@ -111,7 +112,7 @@ def split_name(data: MigrationData) -> MigrationData:
 
 
 @manager.migration("User", "2.0.0", "3.0.0")
-def add_email(data: MigrationData) -> MigrationData:
+def add_email(data: ModelData) -> ModelData:
     return {
         **data,
         "email": f"{data['first_name'].lower()}@example.com"
@@ -133,6 +134,9 @@ print(current_user)
 ```python
 # See exactly what changed between versions
 diff = manager.diff("User", "1.0.0", "3.0.0")
+print(f"Added: {diff.added_fields}")
+print(f"Removed: {diff.removed_fields}")
+# Render a changelog to Markdown
 print(diff.to_markdown(header_depth=4))
 ```
 
@@ -236,8 +240,9 @@ manager.dump_schemas("schemas/")
 # Creates: User_v1.0.0.json, User_v2.0.0.json, User_v3.0.0.json
 
 # Use separate files with $ref for nested models with 'enable_ref=True'.
-manager.dump_schemas_with_refs(
+manager.dump_schemas(
     "schemas/",
+    separate_definitions=True,
     ref_template="https://api.example.com/schemas/{model}_v{version}.json"
 )
 ```
@@ -267,7 +272,7 @@ config = manager.migrate({"timeout": 60}, "Config", "1.0.0", "2.0.0")
 ```python
 from datetime import datetime
 from pydantic import BaseModel, EmailStr
-from pyrmute import ModelManager, MigrationData
+from pyrmute import ModelManager, ModelData
 
 manager = ModelManager()
 
@@ -308,12 +313,12 @@ class OrderV3(BaseModel):
 
 # Define migrations
 @manager.migration("Order", "1.0.0", "2.0.0")
-def add_customer_email(data: MigrationData) -> MigrationData:
+def add_customer_email(data: ModelData) -> ModelData:
     return {**data, "customer_email": "customer@example.com"}
 
 
 @manager.migration("Order", "2.0.0", "3.0.0")
-def structure_items(data: MigrationData) -> MigrationData:
+def structure_items(data: ModelData) -> ModelData:
     # Convert simple strings to structured items
     structured_items = [
         {

pyrmute-0.3.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+pyrmute/__init__.py,sha256=vB0WBe3CukMBDnK0XP4qqehbMM4z_TUQMcTVPCUyt6Q,1082
+pyrmute/_migration_manager.py,sha256=KregnRUKqF1TC9XIpGAHpQvFlnRTEnp2X6Q2sAay8D4,12489
+pyrmute/_registry.py,sha256=iUjMPd6CYgyvWT8PxZqHWBZnsHrX25fOPDi_-k_QDJs,6124
+pyrmute/_schema_manager.py,sha256=eun8PTL9Gv1XAMVKmE3tYmjdrcf701-IapUXjb6WDL0,12122
+pyrmute/_version.py,sha256=5zTqm8rgXsWYBpB2M3Zw_K1D-aV8wP7NsBLrmMKkrAQ,704
+pyrmute/exceptions.py,sha256=Q57cUuzzMdkIl5Q0_VyLobpdB0WcrE0ggfC-LBoX2Uo,1681
+pyrmute/migration_testing.py,sha256=dOR8BDzmz4mFAI4hFtDUCEMS8Qc8qqD_iOV0qRai-qM,4967
+pyrmute/model_diff.py,sha256=vMa2NTYFqt9E7UYDZH4PQmLcoxQw5Sj-nPpUHB_53Ig,9594
+pyrmute/model_manager.py,sha256=e3UKFo79pkseCUFXIzW2_onu3GYjAnY1FR4JR_QF-Gc,24596
+pyrmute/model_version.py,sha256=ftNDuJlN3S5ZKQK8DKqqwfBDRiz4rGCYn-aJ3n6Zmqk,2025
+pyrmute/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyrmute/types.py,sha256=56IH8Rl9AmVh_w3V6PbSSEwaPrBSfc4pYrtcxodvlT0,1187
+pyrmute-0.3.0.dist-info/licenses/LICENSE,sha256=otWInySiZeGwhHqQQ7n7nxM5QBSBe2CzeGEmQDZEz8Q,1119
+pyrmute-0.3.0.dist-info/METADATA,sha256=jnRgO76ovFaktYKqq5BMf4tpUc_DYO_drET7c1hPVk0,9580
+pyrmute-0.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pyrmute-0.3.0.dist-info/top_level.txt,sha256=C8QtzqE6yBHkeewSp1QewvsyeHj_VQLYjSa5HLtMiow,8
+pyrmute-0.3.0.dist-info/RECORD,,

pyrmute-0.2.0.dist-info/RECORD

@@ -1,17 +0,0 @@
-pyrmute/__init__.py,sha256=5XCoTvVxwlDF15tgv6pNGYsqRlZ8-t4VvxkobImiY54,1033
-pyrmute/_migration_manager.py,sha256=rdE8QS4LWO-BWEE11TW64whZHsdTEutkBPpKlKY6gS8,12517
-pyrmute/_registry.py,sha256=iUjMPd6CYgyvWT8PxZqHWBZnsHrX25fOPDi_-k_QDJs,6124
-pyrmute/_schema_manager.py,sha256=OFqq96D0A9Wmwmne8QEtzgBYWeqOBGiGecfxFpRVVQ8,11939
-pyrmute/_version.py,sha256=Dg8AmJomLVpjKL6prJylOONZAPRtB86LOce7dorQS_A,704
-pyrmute/exceptions.py,sha256=Q57cUuzzMdkIl5Q0_VyLobpdB0WcrE0ggfC-LBoX2Uo,1681
-pyrmute/migration_testing.py,sha256=ZofbVAgqSIm1WvOovYE6QLdorEtjcU9bYeUZU_9mqlk,4983
-pyrmute/model_diff.py,sha256=vMa2NTYFqt9E7UYDZH4PQmLcoxQw5Sj-nPpUHB_53Ig,9594
-pyrmute/model_manager.py,sha256=BVa8yznbvdOlrHPpBA7PLdDyOUnnwFHxp9O_zUOgjMk,25526
-pyrmute/model_version.py,sha256=ftNDuJlN3S5ZKQK8DKqqwfBDRiz4rGCYn-aJ3n6Zmqk,2025
-pyrmute/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pyrmute/types.py,sha256=1C5PrgvxUAtGjbsmcYpgOq0BrLr4BgEwWDe4Nl6JhRc,1038
-pyrmute-0.2.0.dist-info/licenses/LICENSE,sha256=otWInySiZeGwhHqQQ7n7nxM5QBSBe2CzeGEmQDZEz8Q,1119
-pyrmute-0.2.0.dist-info/METADATA,sha256=V6qStLPkl95Uuitb4UlFJEFKzxM76mTopmhGlvkKmTs,9437
-pyrmute-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pyrmute-0.2.0.dist-info/top_level.txt,sha256=C8QtzqE6yBHkeewSp1QewvsyeHj_VQLYjSa5HLtMiow,8
-pyrmute-0.2.0.dist-info/RECORD,,