refactor: extract *ComplexAttribute classes in their own file

Author: azmeuk

scim2_models/__init__.py

@@ -3,9 +3,9 @@
 from .annotations import Required
 from .annotations import Returned
 from .annotations import Uniqueness
+from .attributes import ComplexAttribute
+from .attributes import MultiValuedComplexAttribute
 from .base import BaseModel
-from .base import ComplexAttribute
-from .base import MultiValuedComplexAttribute
 from .context import Context
 from .reference import ExternalReference
 from .reference import Reference

scim2_models/attributes.py

@@ -0,0 +1,57 @@
+from inspect import isclass
+from typing import Annotated
+from typing import Any
+from typing import Optional
+from typing import get_origin
+
+from pydantic import Field
+
+from .annotations import Mutability
+
+# This import will work because we'll import this module after BaseModel is defined
+from .base import BaseModel
+from .reference import Reference
+
+
+class ComplexAttribute(BaseModel):
+    """A complex attribute as defined in :rfc:`RFC7643 §2.3.8 <7643#section-2.3.8>`."""
+
+    _schema: Optional[str] = None
+
+    def get_attribute_urn(self, field_name: str) -> str:
+        """Build the full URN of the attribute.
+
+        See :rfc:`RFC7644 §3.10 <7644#section-3.10>`.
+        """
+        alias = (
+            self.__class__.model_fields[field_name].serialization_alias or field_name
+        )
+        return f"{self._schema}.{alias}"
+
+
+class MultiValuedComplexAttribute(ComplexAttribute):
+    type: Optional[str] = None
+    """A label indicating the attribute's function."""
+
+    primary: Optional[bool] = None
+    """A Boolean value indicating the 'primary' or preferred attribute value
+    for this attribute."""
+
+    display: Annotated[Optional[str], Mutability.immutable] = None
+    """A human-readable name, primarily used for display purposes."""
+
+    value: Optional[Any] = None
+    """The value of an entitlement."""
+
+    ref: Optional[Reference] = Field(None, serialization_alias="$ref")
+    """The reference URI of a target resource, if the attribute is a
+    reference."""
+
+
+def is_complex_attribute(type_: type) -> bool:
+    # issubclass raise a TypeError with 'Reference' on python < 3.11
+    return (
+        get_origin(type_) != Reference
+        and isclass(type_)
+        and issubclass(type_, (ComplexAttribute, MultiValuedComplexAttribute))
+    )

scim2_models/base.py

@@ -1,5 +1,4 @@
 from inspect import isclass
-from typing import Annotated
 from typing import Any
 from typing import Optional
 from typing import get_args
@@ -8,7 +7,6 @@
 from pydantic import AliasGenerator
 from pydantic import BaseModel as PydanticBaseModel
 from pydantic import ConfigDict
-from pydantic import Field
 from pydantic import FieldSerializationInfo
 from pydantic import SerializationInfo
 from pydantic import SerializerFunctionWrapHandler
@@ -25,7 +23,6 @@
 from scim2_models.annotations import Required
 from scim2_models.annotations import Returned
 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
 
@@ -341,6 +338,8 @@ def check_mutability_issues(
         cls, original: "BaseModel", replacement: "BaseModel"
     ) -> None:
         """Compare two instances, and check for differences of values on the fields marked as immutable."""
+        from .attributes import is_complex_attribute
+
         model = replacement.__class__
         for field_name in model.model_fields:
             mutability = model.get_field_annotation(field_name, Mutability)
@@ -371,6 +370,8 @@ def mark_with_schema(self) -> None:
         """
         from scim2_models.rfc7643.resource import Resource
 
+        from .attributes import is_complex_attribute
+
         for field_name in self.__class__.model_fields:
             attr_type = self.get_field_root_type(field_name)
             if not attr_type or not is_complex_attribute(attr_type):
@@ -579,48 +580,4 @@ def get_attribute_urn(self, field_name: str) -> str:
         return full_urn
 
 
-class ComplexAttribute(BaseModel):
-    """A complex attribute as defined in :rfc:`RFC7643 §2.3.8 <7643#section-2.3.8>`."""
-
-    _schema: Optional[str] = None
-
-    def get_attribute_urn(self, field_name: str) -> str:
-        """Build the full URN of the attribute.
-
-        See :rfc:`RFC7644 §3.10 <7644#section-3.10>`.
-        """
-        alias = (
-            self.__class__.model_fields[field_name].serialization_alias or field_name
-        )
-        return f"{self._schema}.{alias}"
-
-
-class MultiValuedComplexAttribute(ComplexAttribute):
-    type: Optional[str] = None
-    """A label indicating the attribute's function."""
-
-    primary: Optional[bool] = None
-    """A Boolean value indicating the 'primary' or preferred attribute value
-    for this attribute."""
-
-    display: Annotated[Optional[str], Mutability.immutable] = None
-    """A human-readable name, primarily used for display purposes."""
-
-    value: Optional[Any] = None
-    """The value of an entitlement."""
-
-    ref: Optional[Reference] = Field(None, serialization_alias="$ref")
-    """The reference URI of a target resource, if the attribute is a
-    reference."""
-
-
-def is_complex_attribute(type_: type) -> bool:
-    # issubclass raise a TypeError with 'Reference' on python < 3.11
-    return (
-        get_origin(type_) != Reference
-        and isclass(type_)
-        and issubclass(type_, (ComplexAttribute, MultiValuedComplexAttribute))
-    )
-
-
 BaseModelType: type = type(BaseModel)

scim2_models/rfc7643/enterprise_user.py

@@ -4,9 +4,9 @@
 
 from pydantic import Field
 
-from ..base import ComplexAttribute
-from ..base import Mutability
-from ..base import Required
+from ..annotations import Mutability
+from ..annotations import Required
+from ..attributes import ComplexAttribute
 from ..reference import Reference
 from .resource import Extension
 

scim2_models/rfc7643/group.py

@@ -6,10 +6,10 @@
 
 from pydantic import Field
 
-from ..base import ComplexAttribute
-from ..base import MultiValuedComplexAttribute
-from ..base import Mutability
-from ..base import Required
+from ..annotations import Mutability
+from ..annotations import Required
+from ..attributes import ComplexAttribute
+from ..attributes import MultiValuedComplexAttribute
 from ..reference import Reference
 from .resource import Resource
 

scim2_models/rfc7643/resource.py

@@ -24,11 +24,11 @@
 from ..annotations import Required
 from ..annotations import Returned
 from ..annotations import Uniqueness
+from ..attributes import ComplexAttribute
+from ..attributes import MultiValuedComplexAttribute
+from ..attributes import is_complex_attribute
 from ..base import BaseModel
 from ..base import BaseModelType
-from ..base import ComplexAttribute
-from ..base import MultiValuedComplexAttribute
-from ..base import is_complex_attribute
 from ..reference import ExternalReference
 from ..reference import URIReference
 from ..utils import UNION_TYPES

scim2_models/rfc7643/resource_type.py

@@ -10,7 +10,7 @@
 from ..annotations import Mutability
 from ..annotations import Required
 from ..annotations import Returned
-from ..base import ComplexAttribute
+from ..attributes import ComplexAttribute
 from ..reference import Reference
 from ..reference import URIReference
 from ..utils import UNION_TYPES

scim2_models/rfc7643/schema.py

@@ -21,10 +21,10 @@
 from ..annotations import Required
 from ..annotations import Returned
 from ..annotations import Uniqueness
+from ..attributes import ComplexAttribute
+from ..attributes import MultiValuedComplexAttribute
+from ..attributes import is_complex_attribute
 from ..base import BaseModel
-from ..base import ComplexAttribute
-from ..base import MultiValuedComplexAttribute
-from ..base import is_complex_attribute
 from ..constants import RESERVED_WORDS
 from ..reference import ExternalReference
 from ..reference import Reference

scim2_models/rfc7643/service_provider_config.py

@@ -8,7 +8,7 @@
 from ..annotations import Required
 from ..annotations import Returned
 from ..annotations import Uniqueness
-from ..base import ComplexAttribute
+from ..attributes import ComplexAttribute
 from ..reference import ExternalReference
 from ..reference import Reference
 from .resource import Resource

scim2_models/rfc7643/user.py

@@ -13,8 +13,8 @@
 from ..annotations import Required
 from ..annotations import Returned
 from ..annotations import Uniqueness
-from ..base import ComplexAttribute
-from ..base import MultiValuedComplexAttribute
+from ..attributes import ComplexAttribute
+from ..attributes import MultiValuedComplexAttribute
 from ..reference import ExternalReference
 from ..reference import Reference
 from ..utils import Base64Bytes