refactor: extract Reference in its own file

Author: azmeuk

scim2_models/__init__.py

@@ -1,15 +1,15 @@
 from .base import BaseModel
 from .base import CaseExact
 from .base import ComplexAttribute
-from .base import Context
-from .base import ExternalReference
 from .base import MultiValuedComplexAttribute
 from .base import Mutability
-from .base import Reference
 from .base import Required
 from .base import Returned
 from .base import Uniqueness
-from .base import URIReference
+from .context import Context
+from .reference import ExternalReference
+from .reference import Reference
+from .reference import URIReference
 from .rfc7643.enterprise_user import EnterpriseUser
 from .rfc7643.enterprise_user import Manager
 from .rfc7643.group import Group

scim2_models/base.py

@@ -1,11 +1,8 @@
-from collections import UserString
 from enum import Enum
 from inspect import isclass
 from typing import Annotated
 from typing import Any
-from typing import Generic
 from typing import Optional
-from typing import TypeVar
 from typing import get_args
 from typing import get_origin
 
@@ -14,7 +11,6 @@
 from pydantic import ConfigDict
 from pydantic import Field
 from pydantic import FieldSerializationInfo
-from pydantic import GetCoreSchemaHandler
 from pydantic import SerializationInfo
 from pydantic import SerializerFunctionWrapHandler
 from pydantic import ValidationInfo
@@ -24,20 +20,15 @@
 from pydantic import model_serializer
 from pydantic import model_validator
 from pydantic_core import PydanticCustomError
-from pydantic_core import core_schema
-from typing_extensions import NewType
 from typing_extensions import Self
 
 from scim2_models.context import Context
+from scim2_models.reference import Reference
 from scim2_models.utils import normalize_attribute_name
 from scim2_models.utils import to_camel
 
 from .utils import UNION_TYPES
 
-ReferenceTypes = TypeVar("ReferenceTypes")
-URIReference = NewType("URIReference", str)
-ExternalReference = NewType("ExternalReference", str)
-
 
 def validate_model_attribute(model: type["BaseModel"], attribute_base: str) -> None:
     """Validate that an attribute name or a sub-attribute path exist for a given model."""
@@ -125,43 +116,6 @@ def contains_attribute_or_subattributes(
     )
 
 
-class Reference(UserString, Generic[ReferenceTypes]):
-    """Reference type as defined in :rfc:`RFC7643 §2.3.7 <7643#section-2.3.7>`.
-
-    References can take different type parameters:
-
-        - Any :class:`~scim2_models.Resource` subtype, or :class:`~typing.ForwardRef` of a Resource subtype, or :data:`~typing.Union` of those,
-        - :data:`~scim2_models.ExternalReference`
-        - :data:`~scim2_models.URIReference`
-
-    Examples
-    --------
-
-    .. code-block:: python
-
-        class Foobar(Resource):
-            bff: Reference[User]
-            managers: Reference[Union["User", "Group"]]
-            photo: Reference[ExternalReference]
-            website: Reference[URIReference]
-
-    """
-
-    @classmethod
-    def __get_pydantic_core_schema__(
-        cls,
-        _source: type[Any],
-        _handler: GetCoreSchemaHandler,
-    ) -> core_schema.CoreSchema:
-        return core_schema.no_info_after_validator_function(
-            cls._validate, core_schema.str_schema()
-        )
-
-    @classmethod
-    def _validate(cls, input_value: str, /) -> str:
-        return input_value
-
-
 class Mutability(str, Enum):
     """A single keyword indicating the circumstances under which the value of the attribute can be (re)defined."""
 

scim2_models/reference.py

@@ -0,0 +1,50 @@
+from collections import UserString
+from typing import Any
+from typing import Generic
+from typing import TypeVar
+
+from pydantic import GetCoreSchemaHandler
+from pydantic_core import core_schema
+from typing_extensions import NewType
+
+ReferenceTypes = TypeVar("ReferenceTypes")
+
+URIReference = NewType("URIReference", str)
+ExternalReference = NewType("ExternalReference", str)
+
+
+class Reference(UserString, Generic[ReferenceTypes]):
+    """Reference type as defined in :rfc:`RFC7643 §2.3.7 <7643#section-2.3.7>`.
+
+    References can take different type parameters:
+
+        - Any :class:`~scim2_models.Resource` subtype, or :class:`~typing.ForwardRef` of a Resource subtype, or :data:`~typing.Union` of those,
+        - :data:`~scim2_models.ExternalReference`
+        - :data:`~scim2_models.URIReference`
+
+    Examples
+    --------
+
+    .. code-block:: python
+
+        class Foobar(Resource):
+            bff: Reference[User]
+            managers: Reference[Union["User", "Group"]]
+            photo: Reference[ExternalReference]
+            website: Reference[URIReference]
+
+    """
+
+    @classmethod
+    def __get_pydantic_core_schema__(
+        cls,
+        _source: type[Any],
+        _handler: GetCoreSchemaHandler,
+    ) -> core_schema.CoreSchema:
+        return core_schema.no_info_after_validator_function(
+            cls._validate, core_schema.str_schema()
+        )
+
+    @classmethod
+    def _validate(cls, input_value: str, /) -> str:
+        return input_value

scim2_models/rfc7643/enterprise_user.py

@@ -6,8 +6,8 @@
 
 from ..base import ComplexAttribute
 from ..base import Mutability
-from ..base import Reference
 from ..base import Required
+from ..reference import Reference
 from .resource import Extension
 
 

scim2_models/rfc7643/group.py

@@ -9,8 +9,8 @@
 from ..base import ComplexAttribute
 from ..base import MultiValuedComplexAttribute
 from ..base import Mutability
-from ..base import Reference
 from ..base import Required
+from ..reference import Reference
 from .resource import Resource
 
 

scim2_models/rfc7643/resource.py

@@ -23,14 +23,14 @@
 from ..base import BaseModelType
 from ..base import CaseExact
 from ..base import ComplexAttribute
-from ..base import ExternalReference
 from ..base import MultiValuedComplexAttribute
 from ..base import Mutability
 from ..base import Required
 from ..base import Returned
 from ..base import Uniqueness
-from ..base import URIReference
 from ..base import is_complex_attribute
+from ..reference import ExternalReference
+from ..reference import URIReference
 from ..utils import UNION_TYPES
 from ..utils import normalize_attribute_name
 

scim2_models/rfc7643/resource_type.py

@@ -9,10 +9,10 @@
 from ..base import CaseExact
 from ..base import ComplexAttribute
 from ..base import Mutability
-from ..base import Reference
 from ..base import Required
 from ..base import Returned
-from ..base import URIReference
+from ..reference import Reference
+from ..reference import URIReference
 from ..utils import UNION_TYPES
 from .resource import Resource
 

scim2_models/rfc7643/schema.py

@@ -19,16 +19,16 @@
 from ..base import BaseModel
 from ..base import CaseExact
 from ..base import ComplexAttribute
-from ..base import ExternalReference
 from ..base import MultiValuedComplexAttribute
 from ..base import Mutability
-from ..base import Reference
 from ..base import Required
 from ..base import Returned
 from ..base import Uniqueness
-from ..base import URIReference
 from ..base import is_complex_attribute
 from ..constants import RESERVED_WORDS
+from ..reference import ExternalReference
+from ..reference import Reference
+from ..reference import URIReference
 from ..utils import Base64Bytes
 from ..utils import normalize_attribute_name
 from .resource import Extension

scim2_models/rfc7643/service_provider_config.py

@@ -5,12 +5,12 @@
 from pydantic import Field
 
 from ..base import ComplexAttribute
-from ..base import ExternalReference
 from ..base import Mutability
-from ..base import Reference
 from ..base import Required
 from ..base import Returned
 from ..base import Uniqueness
+from ..reference import ExternalReference
+from ..reference import Reference
 from .resource import Resource
 
 

scim2_models/rfc7643/user.py

@@ -10,13 +10,13 @@
 
 from ..base import CaseExact
 from ..base import ComplexAttribute
-from ..base import ExternalReference
 from ..base import MultiValuedComplexAttribute
 from ..base import Mutability
-from ..base import Reference
 from ..base import Required
 from ..base import Returned
 from ..base import Uniqueness
+from ..reference import ExternalReference
+from ..reference import Reference
 from ..utils import Base64Bytes
 from .resource import AnyExtension
 from .resource import Resource