scim2-models 0.2.9__py3-none-any.whl → 0.2.11__py3-none-any.whl

scim2_models/rfc7643/enterprise_user.py

@@ -26,7 +26,9 @@ class Manager(ComplexAttribute):
 
 
 class EnterpriseUser(Extension):
-    schemas: list[str] = ["urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"]
+    schemas: Annotated[list[str], Required.true] = [
+        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
+    ]
 
     employee_number: Optional[str] = None
     """Numeric or alphanumeric identifier assigned to a person, typically based

scim2_models/rfc7643/group.py

@@ -8,6 +8,7 @@ from pydantic import Field
 from ..base import MultiValuedComplexAttribute
 from ..base import Mutability
 from ..base import Reference
+from ..base import Required
 from .resource import Resource
 
 
@@ -31,7 +32,9 @@ class GroupMember(MultiValuedComplexAttribute):
 
 
 class Group(Resource):
-    schemas: list[str] = ["urn:ietf:params:scim:schemas:core:2.0:Group"]
+    schemas: Annotated[list[str], Required.true] = [
+        "urn:ietf:params:scim:schemas:core:2.0:Group"
+    ]
 
     display_name: Optional[str] = None
     """A human-readable name for the Group."""

scim2_models/rfc7643/resource.py

@@ -136,7 +136,7 @@ class ResourceMetaclass(BaseModelType):
 
 
 class Resource(BaseModel, Generic[AnyExtension], metaclass=ResourceMetaclass):
-    schemas: list[str]
+    schemas: Annotated[list[str], Required.true]
     """The "schemas" attribute is a REQUIRED attribute and is an array of
     Strings containing URIs that are used to indicate the namespaces of the
     SCIM schemas that define the attributes present in the current JSON
@@ -229,7 +229,7 @@ class Resource(BaseModel, Generic[AnyExtension], metaclass=ResourceMetaclass):
         return Resource.get_by_schema(resource_types, schema, **kwargs)
 
     @field_serializer("schemas")
-    def set_extension_schemas(self, schemas: list[str]):
+    def set_extension_schemas(self, schemas: Annotated[list[str], Required.true]):
         """Add model extension ids to the 'schemas' attribute."""
         extension_schemas = self.get_extension_models().keys()
         schemas = self.schemas + [

scim2_models/rfc7643/resource_type.py

@@ -35,7 +35,9 @@ class SchemaExtension(ComplexAttribute):
 
 
 class ResourceType(Resource):
-    schemas: list[str] = ["urn:ietf:params:scim:schemas:core:2.0:ResourceType"]
+    schemas: Annotated[list[str], Required.true] = [
+        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
+    ]
 
     name: Annotated[Optional[str], Mutability.read_only, Required.true] = None
     """The resource type name.

scim2_models/rfc7643/schema.py

@@ -9,7 +9,6 @@ from typing import Optional
 from typing import Union
 from typing import get_origin
 
-from pydantic import Base64Bytes
 from pydantic import Field
 from pydantic import create_model
 from pydantic import field_validator
@@ -30,6 +29,7 @@ from ..base import Uniqueness
 from ..base import URIReference
 from ..base import is_complex_attribute
 from ..constants import RESERVED_WORDS
+from ..utils import Base64Bytes
 from ..utils import normalize_attribute_name
 from .resource import Extension
 from .resource import Resource
@@ -65,7 +65,7 @@ def make_python_model(
             if attr.name
         }
         pydantic_attributes["schemas"] = (
-            Optional[list[str]],
+            Annotated[list[str], Required.true],
             Field(default=[obj.id]),
         )
 
@@ -240,7 +240,9 @@ class Attribute(ComplexAttribute):
 
 
 class Schema(Resource):
-    schemas: list[str] = ["urn:ietf:params:scim:schemas:core:2.0:Schema"]
+    schemas: Annotated[list[str], Required.true] = [
+        "urn:ietf:params:scim:schemas:core:2.0:Schema"
+    ]
 
     id: Annotated[Optional[str], Mutability.read_only, Required.true] = None
     """The unique URI of the schema."""
@@ -264,3 +266,10 @@ class Schema(Resource):
     def urn_id(cls, value: str) -> str:
         """Ensure that schema ids are URI, as defined in RFC7643 §7."""
         return str(Url(value))
+
+    def get_attribute(self, attribute_name: str) -> Optional[Attribute]:
+        """Find an attribute by its name."""
+        for attribute in self.attributes or []:
+            if attribute.name == attribute_name:
+                return attribute
+        return None

scim2_models/rfc7643/service_provider_config.py

@@ -94,7 +94,9 @@ class AuthenticationScheme(ComplexAttribute):
 
 
 class ServiceProviderConfig(Resource):
-    schemas: list[str] = ["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"]
+    schemas: Annotated[list[str], Required.true] = [
+        "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"
+    ]
 
     id: Annotated[
         Optional[str], Mutability.read_only, Returned.default, Uniqueness.global_

scim2_models/rfc7643/user.py

@@ -4,7 +4,6 @@ from typing import Literal
 from typing import Optional
 from typing import Union
 
-from pydantic import Base64Bytes
 from pydantic import EmailStr
 from pydantic import Field
 
@@ -17,6 +16,7 @@ from ..base import Reference
 from ..base import Required
 from ..base import Returned
 from ..base import Uniqueness
+from ..utils import Base64Bytes
 from .resource import Resource
 
 
@@ -214,7 +214,9 @@ class X509Certificate(MultiValuedComplexAttribute):
 
 
 class User(Resource):
-    schemas: list[str] = ["urn:ietf:params:scim:schemas:core:2.0:User"]
+    schemas: Annotated[list[str], Required.true] = [
+        "urn:ietf:params:scim:schemas:core:2.0:User"
+    ]
 
     user_name: Annotated[Optional[str], Uniqueness.server, Required.true] = None
     """Unique identifier for the User, typically used by the user to directly

scim2_models/rfc7644/bulk.py

@@ -7,6 +7,7 @@ from pydantic import Field
 from pydantic import PlainSerializer
 
 from ..base import ComplexAttribute
+from ..base import Required
 from ..utils import int_to_str
 from .message import Message
 
@@ -53,7 +54,9 @@ class BulkRequest(Message):
         The models for Bulk operations are defined, but their behavior is not implemented nor tested yet.
     """
 
-    schemas: list[str] = ["urn:ietf:params:scim:api:messages:2.0:BulkRequest"]
+    schemas: Annotated[list[str], Required.true] = [
+        "urn:ietf:params:scim:api:messages:2.0:BulkRequest"
+    ]
 
     fail_on_errors: Optional[int] = None
     """An integer specifying the number of errors that the service provider
@@ -74,7 +77,9 @@ class BulkResponse(Message):
         The models for Bulk operations are defined, but their behavior is not implemented nor tested yet.
     """
 
-    schemas: list[str] = ["urn:ietf:params:scim:api:messages:2.0:BulkResponse"]
+    schemas: Annotated[list[str], Required.true] = [
+        "urn:ietf:params:scim:api:messages:2.0:BulkResponse"
+    ]
 
     operations: Optional[list[BulkOperation]] = Field(
         None, serialization_alias="Operations"

scim2_models/rfc7644/error.py

@@ -3,6 +3,7 @@ from typing import Optional
 
 from pydantic import PlainSerializer
 
+from ..base import Required
 from ..utils import int_to_str
 from .message import Message
 
@@ -10,7 +11,9 @@ from .message import Message
 class Error(Message):
     """Representation of SCIM API errors."""
 
-    schemas: list[str] = ["urn:ietf:params:scim:api:messages:2.0:Error"]
+    schemas: Annotated[list[str], Required.true] = [
+        "urn:ietf:params:scim:api:messages:2.0:Error"
+    ]
 
     status: Annotated[Optional[int], PlainSerializer(int_to_str)] = None
     """The HTTP status code (see Section 6 of [RFC7231]) expressed as a JSON

scim2_models/rfc7644/list_response.py

@@ -18,6 +18,7 @@ from typing_extensions import Self
 from ..base import BaseModel
 from ..base import BaseModelType
 from ..base import Context
+from ..base import Required
 from ..rfc7643.resource import AnyResource
 from .message import Message
 
@@ -78,7 +79,9 @@ class ListResponseMetaclass(BaseModelType):
 
 
 class ListResponse(Message, Generic[AnyResource], metaclass=ListResponseMetaclass):
-    schemas: list[str] = ["urn:ietf:params:scim:api:messages:2.0:ListResponse"]
+    schemas: Annotated[list[str], Required.true] = [
+        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
+    ]
 
     total_results: Optional[int] = None
     """The total number of results returned by the list or query operation."""

scim2_models/rfc7644/message.py

@@ -1,7 +1,10 @@
+from typing import Annotated
+
 from ..base import BaseModel
+from ..base import Required
 
 
 class Message(BaseModel):
     """SCIM protocol messages as defined by :rfc:`RFC7644 §3.1 <7644#section-3.1>`."""
 
-    schemas: list[str]
+    schemas: Annotated[list[str], Required.true]

scim2_models/rfc7644/patch_op.py

@@ -1,4 +1,5 @@
 from enum import Enum
+from typing import Annotated
 from typing import Any
 from typing import Optional
 
@@ -6,6 +7,7 @@ from pydantic import Field
 from pydantic import field_validator
 
 from ..base import ComplexAttribute
+from ..base import Required
 from .message import Message
 
 
@@ -57,7 +59,9 @@ class PatchOp(Message):
         The models for Patch operations are defined, but their behavior is not implemented nor tested yet.
     """
 
-    schemas: list[str] = ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]
+    schemas: Annotated[list[str], Required.true] = [
+        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
+    ]
 
     operations: Optional[list[PatchOperation]] = Field(
         None, serialization_alias="Operations"

scim2_models/rfc7644/search_request.py

@@ -1,9 +1,11 @@
 from enum import Enum
+from typing import Annotated
 from typing import Optional
 
 from pydantic import field_validator
 from pydantic import model_validator
 
+from ..base import Required
 from .message import Message
 
 
@@ -13,7 +15,9 @@ class SearchRequest(Message):
     https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.3
     """
 
-    schemas: list[str] = ["urn:ietf:params:scim:api:messages:2.0:SearchRequest"]
+    schemas: Annotated[list[str], Required.true] = [
+        "urn:ietf:params:scim:api:messages:2.0:SearchRequest"
+    ]
 
     attributes: Optional[list[str]] = None
     """A multi-valued list of strings indicating the names of resource
@@ -72,3 +76,17 @@ class SearchRequest(Message):
             )
 
         return self
+
+    @property
+    def start_index_0(self):
+        """The 0 indexed start index."""
+        return self.start_index - 1 if self.start_index is not None else None
+
+    @property
+    def stop_index_0(self):
+        """The 0 indexed stop index."""
+        return (
+            self.start_index_0 + self.count
+            if self.start_index_0 is not None and self.count is not None
+            else None
+        )

scim2_models/utils.py

@@ -1,8 +1,14 @@
+import base64
 import re
+from typing import Annotated
+from typing import Literal
 from typing import Optional
 from typing import Union
 
+from pydantic import EncodedBytes
+from pydantic import EncoderProtocol
 from pydantic.alias_generators import to_snake
+from pydantic_core import PydanticCustomError
 
 try:
     from types import UnionType  # type: ignore
@@ -17,6 +23,57 @@ def int_to_str(status: Optional[int]) -> Optional[str]:
     return None if status is None else str(status)
 
 
+# Copied from Pydantic 2.10 repository
+class Base64Encoder(EncoderProtocol):  # pragma: no cover
+    """Standard (non-URL-safe) Base64 encoder."""
+
+    @classmethod
+    def decode(cls, data: bytes) -> bytes:
+        """Decode the data from base64 encoded bytes to original bytes data.
+
+        Args:
+            data: The data to decode.
+
+        Returns:
+            The decoded data.
+
+        """
+        try:
+            return base64.b64decode(data)
+        except ValueError as e:
+            raise PydanticCustomError(
+                "base64_decode", "Base64 decoding error: '{error}'", {"error": str(e)}
+            ) from e
+
+    @classmethod
+    def encode(cls, value: bytes) -> bytes:
+        """Encode the data from bytes to a base64 encoded bytes.
+
+        Args:
+            value: The data to encode.
+
+        Returns:
+            The encoded data.
+
+        """
+        return base64.b64encode(value)
+
+    @classmethod
+    def get_json_format(cls) -> Literal["base64"]:
+        """Get the JSON format for the encoded data.
+
+        Returns:
+            The JSON format for the encoded data.
+
+        """
+        return "base64"
+
+
+# Compatibility with Pydantic <2.10
+# https://pydantic.dev/articles/pydantic-v2-10-release#use-b64decode-and-b64encode-for-base64bytes-and-base64str-types
+Base64Bytes = Annotated[bytes, EncodedBytes(encoder=Base64Encoder)]
+
+
 def to_camel(string: str) -> str:
     """Transform strings to camelCase.
 

{scim2_models-0.2.9.dist-info → scim2_models-0.2.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: scim2-models
-Version: 0.2.9
+Version: 0.2.11
 Summary: SCIM2 models serialization and validation with pydantic
 Project-URL: documentation, https://scim2-models.readthedocs.io
 Project-URL: repository, https://github.com/python-scim/scim2-models

scim2_models-0.2.11.dist-info/RECORD

@@ -0,0 +1,24 @@
+scim2_models/__init__.py,sha256=Y06vTA_51lXfv9zk_dTzyIIqEo1H2bcencvMM5KAwn8,3063
+scim2_models/base.py,sha256=_RTwLpwyiyKTc7VYuB854yuPhr8gakahmrOFTKTxHFI,32268
+scim2_models/constants.py,sha256=SuMGFtVNletdV5ZJRUcIq7o2CqZCRvOurnIdLE_cakE,540
+scim2_models/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scim2_models/utils.py,sha256=MzZz212-lkVWgXcpXvNwoi_u28wBTpkTwPrfYC5v92A,2771
+scim2_models/rfc7643/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scim2_models/rfc7643/enterprise_user.py,sha256=EaxdHH2dcBrwWwGpaZC6iZ9dbcaVN1NpoRLAdkTYssQ,1781
+scim2_models/rfc7643/group.py,sha256=CBmSnlzd4JktCpOmg4XkfJJUd8oD6KbYFRTt0dSdixE,1302
+scim2_models/rfc7643/resource.py,sha256=zMyk02Traoq6XNBcS_fSnXIOadZwxTdA9CV4vLuy38k,12648
+scim2_models/rfc7643/resource_type.py,sha256=p8IKV5IakPMBX6d2Fv2MFqaQL5iTw152vmozVVSC8gU,3196
+scim2_models/rfc7643/schema.py,sha256=tYKxQP791Vm58xjgaIyQmRF8WP04EPkJrP_OtzusHXA,9642
+scim2_models/rfc7643/service_provider_config.py,sha256=deMNCXlqiNzuLcVRN9mdHiTUxhczDnvi-oO6k-Anj8U,5402
+scim2_models/rfc7643/user.py,sha256=-wlO2IC0MxFWUJpaddEwAG5LsEcORnbHfkRwGG3fVSk,9942
+scim2_models/rfc7644/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scim2_models/rfc7644/bulk.py,sha256=I6S40kyJPwDQwPFi668wFFDVTST7z6QTe9HTL5QUViI,2577
+scim2_models/rfc7644/error.py,sha256=l4-vtGQYm5u13-ParhbHSeqXEil0E09QXSO9twAT3SU,6185
+scim2_models/rfc7644/list_response.py,sha256=Zh8Od2iOd3kinwLP-PHQMEbfM1tdl111Qap9DR8DHc4,4251
+scim2_models/rfc7644/message.py,sha256=F4kPqbHAka3-wZzap9a45noQZw-o1vznTJypNABBF7w,253
+scim2_models/rfc7644/patch_op.py,sha256=OE-ixDanTkY5zQP7EK7OAp88uE_fMk03mqmaZHxgJ-g,2210
+scim2_models/rfc7644/search_request.py,sha256=X3DZQOtLu8EWYvkNfNOcFlGtx3TGNEkpL59dAdut7Sc,3006
+scim2_models-0.2.11.dist-info/METADATA,sha256=mfd5sP_S-WqTDypsNmGp8e0GvJLbzNM9S8Dpi4hL4_g,16267
+scim2_models-0.2.11.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+scim2_models-0.2.11.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+scim2_models-0.2.11.dist-info/RECORD,,

scim2_models-0.2.9.dist-info/RECORD

@@ -1,24 +0,0 @@
-scim2_models/__init__.py,sha256=Y06vTA_51lXfv9zk_dTzyIIqEo1H2bcencvMM5KAwn8,3063
-scim2_models/base.py,sha256=_RTwLpwyiyKTc7VYuB854yuPhr8gakahmrOFTKTxHFI,32268
-scim2_models/constants.py,sha256=SuMGFtVNletdV5ZJRUcIq7o2CqZCRvOurnIdLE_cakE,540
-scim2_models/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scim2_models/utils.py,sha256=2QptWn3e74nVmemMEPsm80m8bJ9IL7PUgzOTRDWoq10,1216
-scim2_models/rfc7643/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scim2_models/rfc7643/enterprise_user.py,sha256=trwVpCZT0FXGFFyo57L4ME7h0gnFstYdWAm6mqFRfOM,1741
-scim2_models/rfc7643/group.py,sha256=5EmJsjlWdj_vnrtn4k3iwrPq3vVG0yntpHVRT7hhq5Q,1234
-scim2_models/rfc7643/resource.py,sha256=FlrIFPq7kZiOesBtzrM_844pH5OWiCb63VEXnVb9NuI,12596
-scim2_models/rfc7643/resource_type.py,sha256=dD6H1qeUM7HQMMRFHqnyruT7dzkIDLUBPXV-mPeZOoc,3156
-scim2_models/rfc7643/schema.py,sha256=RJiCfx4lseqIXESnqK0PqrBcjPlOgiKgsAeacPYvmjM,9318
-scim2_models/rfc7643/service_provider_config.py,sha256=uHSVDkLfjzGmjQJQ-8B_s34wgOvG_wd5tE37fJEeSTI,5362
-scim2_models/rfc7643/user.py,sha256=ctPO2ujeXI-p8yJWkFEaHKYrYnOWq4RGgMV6hY3nNB4,9903
-scim2_models/rfc7644/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scim2_models/rfc7644/bulk.py,sha256=wgLBhV3AbD6z7KVP9SpvP2_sgGSXkHJ4kk9XvM40Ikg,2469
-scim2_models/rfc7644/error.py,sha256=_zYjAn7kK8hA4HAX6n9kcqCOMxRiPibzUuun7wah5xo,6117
-scim2_models/rfc7644/list_response.py,sha256=mewgLvo8UKqvb4DVoSHX16Hj5P4ijUHEczFluxV-GWU,4183
-scim2_models/rfc7644/message.py,sha256=Kie5G8XTKiJYAQ8WzPE17UWaMhtNDW6OYdvCkaq14XE,169
-scim2_models/rfc7644/patch_op.py,sha256=gxydWwvEFJwiHwXuHxf4OSnL7b-oEsU6vaFvK9mSB0A,2113
-scim2_models/rfc7644/search_request.py,sha256=bO_jxTNuIFo98zPjiM1eH3XnA_UXFiSQnoVISjV0FYw,2497
-scim2_models-0.2.9.dist-info/METADATA,sha256=gu79yS0dSzmzSbgYAmK9v66SE8Ve8fvAReNBr2OqhJw,16266
-scim2_models-0.2.9.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-scim2_models-0.2.9.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-scim2_models-0.2.9.dist-info/RECORD,,