fix: put UNION_TYPES back in the ~public API

Author: azmeuk

scim2_models/base.py

@@ -23,7 +23,7 @@
 from scim2_models.annotations import Required
 from scim2_models.annotations import Returned
 from scim2_models.context import Context
-from scim2_models.utils import _UNION_TYPES
+from scim2_models.utils import UNION_TYPES
 from scim2_models.utils import _find_field_name
 from scim2_models.utils import _normalize_attribute_name
 from scim2_models.utils import _to_camel
@@ -77,7 +77,7 @@ def get_field_root_type(cls, attribute_name: str) -> Optional[type]:
         attribute_type = cls.model_fields[attribute_name].annotation
 
         # extract 'x' from 'Optional[x]'
-        if get_origin(attribute_type) in _UNION_TYPES:
+        if get_origin(attribute_type) in UNION_TYPES:
             attribute_type = get_args(attribute_type)[0]
 
         # extract 'x' from 'List[x]'
@@ -93,7 +93,7 @@ def get_field_multiplicity(cls, attribute_name: str) -> bool:
         attribute_type = cls.model_fields[attribute_name].annotation
 
         # extract 'x' from 'Optional[x]'
-        if get_origin(attribute_type) in _UNION_TYPES:
+        if get_origin(attribute_type) in UNION_TYPES:
             attribute_type = get_args(attribute_type)[0]
 
         origin = get_origin(attribute_type)
@@ -104,7 +104,7 @@ def get_field_multiplicity(cls, attribute_name: str) -> bool:
     def check_request_attributes_mutability(
         cls, value: Any, info: ValidationInfo
     ) -> Any:
-        """Check and fix that the field mutability is expected according to the requests validation context, as defined in :rfc:`RFC7643 §7 <7653#section-7>`."""
+        """Check and fix that the field mutability is expected according to the requests validation context, as defined in :rfc:`RFC7643 §7 <7643#section-7>`."""
         if (
             not info.context
             or not info.field_name
@@ -147,7 +147,7 @@ def normalize_attribute_names(
     ) -> Self:
         """Normalize payload attribute names.
 
-        :rfc:`RFC7643 §2.1 <7653#section-2.1>` indicate that attribute
+        :rfc:`RFC7643 §2.1 <7643#section-2.1>` indicate that attribute
         names should be case-insensitive. Any attribute name is
         transformed in lowercase so any case is handled the same way.
         """
@@ -199,7 +199,7 @@ def normalize_value(
     def check_response_attributes_returnability(
         cls, value: Any, handler: ValidatorFunctionWrapHandler, info: ValidationInfo
     ) -> Self:
-        """Check that the fields returnability is expected according to the responses validation context, as defined in :rfc:`RFC7643 §7 <7653#section-7>`."""
+        """Check that the fields returnability is expected according to the responses validation context, as defined in :rfc:`RFC7643 §7 <7643#section-7>`."""
         obj = handler(value)
         assert isinstance(obj, cls)
 

scim2_models/context.py

@@ -78,7 +78,7 @@ class Context(Enum):
 
     - When used for serialization, it will not dump attributes annotated with :attr:`~scim2_models.Mutability.read_only`.
     - When used for validation, it will ignore attributes annotated with :attr:`scim2_models.Mutability.read_only` and raise a :class:`~pydantic.ValidationError`:
-        - when finding attributes annotated with :attr:`~scim2_models.Mutability.immutable` different than :paramref:`~scim2_models.BaseModel.model_validate.original`:
+        - when finding attributes annotated with :attr:`~scim2_models.Mutability.immutable` different than the ``original`` parameter passed to :meth:`~scim2_models.BaseModel.model_validate`;
         - when attributes annotated with :attr:`Required.true <scim2_models.Required.true>` are missing on null.
     """
 

scim2_models/messages/message.py

@@ -14,7 +14,7 @@
 
 from ..base import BaseModel
 from ..scim_object import ScimObject
-from ..utils import _UNION_TYPES
+from ..utils import UNION_TYPES
 
 
 class Message(ScimObject):
@@ -69,7 +69,7 @@ def _create_tagged_resource_union(resource_union: Any) -> Any:
     :param resource_union: Union type of SCIM resources
     :return: Annotated discriminated union or original type
     """
-    if get_origin(resource_union) not in _UNION_TYPES:
+    if get_origin(resource_union) not in UNION_TYPES:
         return resource_union
 
     resource_types = get_args(resource_union)

scim2_models/reference.py

@@ -9,7 +9,7 @@
 from pydantic_core import core_schema
 from typing_extensions import NewType
 
-from .utils import _UNION_TYPES
+from .utils import UNION_TYPES
 
 ReferenceTypes = TypeVar("ReferenceTypes")
 
@@ -67,9 +67,7 @@ def get_types(cls, type_annotation: Any) -> list[str]:
         """
         first_arg = get_args(type_annotation)[0]
         types = (
-            get_args(first_arg)
-            if get_origin(first_arg) in _UNION_TYPES
-            else [first_arg]
+            get_args(first_arg) if get_origin(first_arg) in UNION_TYPES else [first_arg]
         )
 
         def serialize_ref_type(ref_type: Any) -> str:

scim2_models/resources/resource.py

@@ -29,7 +29,7 @@
 from ..reference import Reference
 from ..scim_object import ScimObject
 from ..urn import _validate_attribute_urn
-from ..utils import _UNION_TYPES
+from ..utils import UNION_TYPES
 from ..utils import _normalize_attribute_name
 
 if TYPE_CHECKING:
@@ -153,7 +153,7 @@ def __class_getitem__(cls, item: Any) -> type["Resource"]:
         if hasattr(cls, "__scim_extension_metadata__"):
             return cls
 
-        extensions = get_args(item) if get_origin(item) in _UNION_TYPES else [item]
+        extensions = get_args(item) if get_origin(item) in UNION_TYPES else [item]
 
         # Skip TypeVar parameters and Any (used for generic class definitions)
         valid_extensions = [

scim2_models/utils.py

@@ -13,10 +13,10 @@
 try:
     from types import UnionType
 
-    _UNION_TYPES = [Union, UnionType]
+    UNION_TYPES = [Union, UnionType]
 except ImportError:
     # Python 3.9 has no UnionType
-    _UNION_TYPES = [Union]
+    UNION_TYPES = [Union]
 
 
 def _int_to_str(status: Optional[int]) -> Optional[str]: