scim2-models 0.2.9__tar.gz → 0.2.11__tar.gz

{scim2_models-0.2.9 → scim2_models-0.2.11}/PKG-INFO

@@ -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.9 → scim2_models-0.2.11}/doc/changelog.rst

@@ -1,6 +1,25 @@
 Changelog
 =========
 
+[0.2.11] - 2024-12-08
+---------------------
+Added
+^^^^^
+- Implement :meth:`Schema.get_attribute <scim2_models.Schema.get_attribute>`.
+- Implement :meth:`SearchRequest.start_index_0 <scim2_models.SearchRequest.start_index_0>`
+  and :meth:`SearchRequest.start_index_1 <scim2_models.SearchRequest.start_index_1>`.
+
+[0.2.10] - 2024-12-02
+---------------------
+
+Changed
+^^^^^^^
+- The ``schema`` attribute is annotated with :attr:`~scim2_models.Required.true`.
+
+Fixed
+^^^^^
+- ``Base64Bytes`` compatibility between pydantic 2.10+ and <2.10
+
 [0.2.9] - 2024-12-02
 --------------------
 

{scim2_models-0.2.9 → scim2_models-0.2.11}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "scim2-models"
-version = "0.2.9"
+version = "0.2.11"
 description = "SCIM2 models serialization and validation with pydantic"
 authors = [{name="Yaal Coop", email="contact@yaal.coop"}]
 license = {file = "LICENSE"}

{scim2_models-0.2.9 → scim2_models-0.2.11}/samples/rfc7643-8.2-user-full.json

@@ -100,7 +100,7 @@
     ],
     "x509Certificates": [
         {
-            "value": "MIIDQzCCAqygAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwTjELMAkGA1UEBhMCVVMxEzARBgNVBAgM\nCkNhbGlmb3JuaWExFDASBgNVBAoMC2V4YW1wbGUuY29tMRQwEgYDVQQDDAtleGFtcGxlLmNvbTAe\nFw0xMTEwMjIwNjI0MzFaFw0xMjEwMDQwNjI0MzFaMH8xCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApD\nYWxpZm9ybmlhMRQwEgYDVQQKDAtleGFtcGxlLmNvbTEhMB8GA1UEAwwYTXMuIEJhcmJhcmEgSiBK\nZW5zZW4gSUlJMSIwIAYJKoZIhvcNAQkBFhNiamVuc2VuQGV4YW1wbGUuY29tMIIBIjANBgkqhkiG\n9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7Kr+Dcds/JQ5GwejJFcBIP682X3xpjis56AK02bc1FLgzdLI\n8auoR+cC9/Vrh5t66HkQIOdA4unHh0AaZ4xL5PhVbXIPMB5vAPKpzz5iPSi8xO8SL7I7SDhcBVJh\nqVqr3HgllEG6UClDdHO7nkLuwXq8HcISKkbT5WFTVfFZzidPl8HZ7DhXkZIRtJwBweq4bvm3hM1O\ns7UQH05ZS6cVDgweKNwdLLrT51ikSQG3DYrl+ft781UQRIqxgwqCfXEuDiinPh0kkvIi5jivVu1Z\n9QiwlYEdRbLJ4zJQBmDrSGTMYn4lRc2HgHO4DqB/bnMVorHB0CC6AV1QoFK4GPe1LwIDAQABo3sw\neTAJBgNVHRMEAjAAMCwGCWCGSAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZpY2F0\nZTAdBgNVHQ4EFgQU8pD0U0vsZIsaA16lL8En8bx0F/gwHwYDVR0jBBgwFoAUdGeKitcaF7gnzsNw\nDx708kqaVt0wDQYJKoZIhvcNAQEFBQADgYEAA81SsFnOdYJtNg5Tcq+/ByEDrBgnusx0jloUhByP\nMEVkoMZ3J7j1ZgI8rAbOkNngX8+pKfTiDz1RC4+dx8oU6Za+4NJXUjlL5CvV6BEYb1+QAEJwitTV\nvxB/A67g42/vzgAtoRUeDov1+GFiBZ+GNF/cAYKcMtGcrs2i97ZkJMo=\n"
+            "value": "MIIDQzCCAqygAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwTjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFDASBgNVBAoMC2V4YW1wbGUuY29tMRQwEgYDVQQDDAtleGFtcGxlLmNvbTAeFw0xMTEwMjIwNjI0MzFaFw0xMjEwMDQwNjI0MzFaMH8xCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRQwEgYDVQQKDAtleGFtcGxlLmNvbTEhMB8GA1UEAwwYTXMuIEJhcmJhcmEgSiBKZW5zZW4gSUlJMSIwIAYJKoZIhvcNAQkBFhNiamVuc2VuQGV4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7Kr+Dcds/JQ5GwejJFcBIP682X3xpjis56AK02bc1FLgzdLI8auoR+cC9/Vrh5t66HkQIOdA4unHh0AaZ4xL5PhVbXIPMB5vAPKpzz5iPSi8xO8SL7I7SDhcBVJhqVqr3HgllEG6UClDdHO7nkLuwXq8HcISKkbT5WFTVfFZzidPl8HZ7DhXkZIRtJwBweq4bvm3hM1Os7UQH05ZS6cVDgweKNwdLLrT51ikSQG3DYrl+ft781UQRIqxgwqCfXEuDiinPh0kkvIi5jivVu1Z9QiwlYEdRbLJ4zJQBmDrSGTMYn4lRc2HgHO4DqB/bnMVorHB0CC6AV1QoFK4GPe1LwIDAQABo3sweTAJBgNVHRMEAjAAMCwGCWCGSAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZpY2F0ZTAdBgNVHQ4EFgQU8pD0U0vsZIsaA16lL8En8bx0F/gwHwYDVR0jBBgwFoAUdGeKitcaF7gnzsNwDx708kqaVt0wDQYJKoZIhvcNAQEFBQADgYEAA81SsFnOdYJtNg5Tcq+/ByEDrBgnusx0jloUhByPMEVkoMZ3J7j1ZgI8rAbOkNngX8+pKfTiDz1RC4+dx8oU6Za+4NJXUjlL5CvV6BEYb1+QAEJwitTVvxB/A67g42/vzgAtoRUeDov1+GFiBZ+GNF/cAYKcMtGcrs2i97ZkJMo="
         }
     ],
     "meta": {

{scim2_models-0.2.9 → scim2_models-0.2.11}/samples/rfc7643-8.3-enterprise_user.json

@@ -101,7 +101,7 @@
     ],
     "x509Certificates": [
         {
-            "value": "MIIDQzCCAqygAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwTjELMAkGA1UEBhMCVVMxEzARBgNVBAgM\nCkNhbGlmb3JuaWExFDASBgNVBAoMC2V4YW1wbGUuY29tMRQwEgYDVQQDDAtleGFtcGxlLmNvbTAe\nFw0xMTEwMjIwNjI0MzFaFw0xMjEwMDQwNjI0MzFaMH8xCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApD\nYWxpZm9ybmlhMRQwEgYDVQQKDAtleGFtcGxlLmNvbTEhMB8GA1UEAwwYTXMuIEJhcmJhcmEgSiBK\nZW5zZW4gSUlJMSIwIAYJKoZIhvcNAQkBFhNiamVuc2VuQGV4YW1wbGUuY29tMIIBIjANBgkqhkiG\n9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7Kr+Dcds/JQ5GwejJFcBIP682X3xpjis56AK02bc1FLgzdLI\n8auoR+cC9/Vrh5t66HkQIOdA4unHh0AaZ4xL5PhVbXIPMB5vAPKpzz5iPSi8xO8SL7I7SDhcBVJh\nqVqr3HgllEG6UClDdHO7nkLuwXq8HcISKkbT5WFTVfFZzidPl8HZ7DhXkZIRtJwBweq4bvm3hM1O\ns7UQH05ZS6cVDgweKNwdLLrT51ikSQG3DYrl+ft781UQRIqxgwqCfXEuDiinPh0kkvIi5jivVu1Z\n9QiwlYEdRbLJ4zJQBmDrSGTMYn4lRc2HgHO4DqB/bnMVorHB0CC6AV1QoFK4GPe1LwIDAQABo3sw\neTAJBgNVHRMEAjAAMCwGCWCGSAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZpY2F0\nZTAdBgNVHQ4EFgQU8pD0U0vsZIsaA16lL8En8bx0F/gwHwYDVR0jBBgwFoAUdGeKitcaF7gnzsNw\nDx708kqaVt0wDQYJKoZIhvcNAQEFBQADgYEAA81SsFnOdYJtNg5Tcq+/ByEDrBgnusx0jloUhByP\nMEVkoMZ3J7j1ZgI8rAbOkNngX8+pKfTiDz1RC4+dx8oU6Za+4NJXUjlL5CvV6BEYb1+QAEJwitTV\nvxB/A67g42/vzgAtoRUeDov1+GFiBZ+GNF/cAYKcMtGcrs2i97ZkJMo=\n"
+            "value": "MIIDQzCCAqygAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwTjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFDASBgNVBAoMC2V4YW1wbGUuY29tMRQwEgYDVQQDDAtleGFtcGxlLmNvbTAeFw0xMTEwMjIwNjI0MzFaFw0xMjEwMDQwNjI0MzFaMH8xCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRQwEgYDVQQKDAtleGFtcGxlLmNvbTEhMB8GA1UEAwwYTXMuIEJhcmJhcmEgSiBKZW5zZW4gSUlJMSIwIAYJKoZIhvcNAQkBFhNiamVuc2VuQGV4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7Kr+Dcds/JQ5GwejJFcBIP682X3xpjis56AK02bc1FLgzdLI8auoR+cC9/Vrh5t66HkQIOdA4unHh0AaZ4xL5PhVbXIPMB5vAPKpzz5iPSi8xO8SL7I7SDhcBVJhqVqr3HgllEG6UClDdHO7nkLuwXq8HcISKkbT5WFTVfFZzidPl8HZ7DhXkZIRtJwBweq4bvm3hM1Os7UQH05ZS6cVDgweKNwdLLrT51ikSQG3DYrl+ft781UQRIqxgwqCfXEuDiinPh0kkvIi5jivVu1Z9QiwlYEdRbLJ4zJQBmDrSGTMYn4lRc2HgHO4DqB/bnMVorHB0CC6AV1QoFK4GPe1LwIDAQABo3sweTAJBgNVHRMEAjAAMCwGCWCGSAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZpY2F0ZTAdBgNVHQ4EFgQU8pD0U0vsZIsaA16lL8En8bx0F/gwHwYDVR0jBBgwFoAUdGeKitcaF7gnzsNwDx708kqaVt0wDQYJKoZIhvcNAQEFBQADgYEAA81SsFnOdYJtNg5Tcq+/ByEDrBgnusx0jloUhByPMEVkoMZ3J7j1ZgI8rAbOkNngX8+pKfTiDz1RC4+dx8oU6Za+4NJXUjlL5CvV6BEYb1+QAEJwitTVvxB/A67g42/vzgAtoRUeDov1+GFiBZ+GNF/cAYKcMtGcrs2i97ZkJMo="
         }
     ],
     "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {

{scim2_models-0.2.9 → scim2_models-0.2.11}/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-0.2.9 → scim2_models-0.2.11}/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-0.2.9 → scim2_models-0.2.11}/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-0.2.9 → scim2_models-0.2.11}/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-0.2.9 → scim2_models-0.2.11}/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-0.2.9 → scim2_models-0.2.11}/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-0.2.9 → scim2_models-0.2.11}/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-0.2.9 → scim2_models-0.2.11}/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-0.2.9 → scim2_models-0.2.11}/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-0.2.9 → scim2_models-0.2.11}/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-0.2.9 → scim2_models-0.2.11}/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-0.2.9 → scim2_models-0.2.11}/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-0.2.9 → scim2_models-0.2.11}/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-0.2.11/scim2_models/utils.py

@@ -0,0 +1,99 @@
+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
+
+    UNION_TYPES = [Union, UnionType]
+except ImportError:
+    # Python 3.9 has no UnionType
+    UNION_TYPES = [Union]
+
+
+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.
+
+    This method is used for attribute name serialization. This is more
+    or less the pydantic implementation, but it does not add uppercase
+    on alphanumerical characters after specials characters. For instance
+    '$ref' stays '$ref'.
+    """
+    snake = to_snake(string)
+    camel = re.sub(r"_+([0-9A-Za-z]+)", lambda m: m.group(1).title(), snake)
+    return camel
+
+
+def normalize_attribute_name(attribute_name: str) -> str:
+    """Remove all non-alphabetical characters and lowerise a string.
+
+    This method is used for attribute name validation.
+    """
+    is_extension_attribute = ":" in attribute_name
+    if not is_extension_attribute:
+        attribute_name = re.sub(r"[\W_]+", "", attribute_name)
+
+    return attribute_name.lower()

{scim2_models-0.2.9 → scim2_models-0.2.11}/tests/test_dynamic_resources.py

@@ -2,8 +2,6 @@ import datetime
 from typing import Literal
 from typing import Union
 
-from pydantic import Base64Bytes
-
 from scim2_models.base import CaseExact
 from scim2_models.base import ComplexAttribute
 from scim2_models.base import ExternalReference
@@ -18,6 +16,7 @@ from scim2_models.rfc7643.resource import Extension
 from scim2_models.rfc7643.resource import Resource
 from scim2_models.rfc7643.schema import Attribute
 from scim2_models.rfc7643.schema import Schema
+from scim2_models.utils import Base64Bytes
 
 
 def test_make_group_model_from_schema(load_sample):

{scim2_models-0.2.9 → scim2_models-0.2.11}/tests/test_list_response.py

@@ -1,3 +1,4 @@
+from typing import Annotated
 from typing import Union
 
 import pytest
@@ -7,6 +8,7 @@ from scim2_models import Context
 from scim2_models import EnterpriseUser
 from scim2_models import Group
 from scim2_models import ListResponse
+from scim2_models import Required
 from scim2_models import Resource
 from scim2_models import ResourceType
 from scim2_models import ServiceProviderConfig
@@ -107,7 +109,7 @@ def test_mixed_types(load_sample):
 
 
 class Foobar(Resource):
-    schemas: list[str] = ["foobarschema"]
+    schemas: Annotated[list[str], Required.true] = ["foobarschema"]
 
 
 def test_mixed_types_type_missing(load_sample):

{scim2_models-0.2.9 → scim2_models-0.2.11}/tests/test_model_attributes.py

@@ -7,9 +7,11 @@ import pytest
 from scim2_models.base import BaseModel
 from scim2_models.base import ComplexAttribute
 from scim2_models.base import Context
+from scim2_models.base import Required
 from scim2_models.base import Returned
 from scim2_models.base import validate_attribute_urn
 from scim2_models.rfc7643.enterprise_user import EnterpriseUser
+from scim2_models.rfc7643.resource import Extension
 from scim2_models.rfc7643.resource import Meta
 from scim2_models.rfc7643.resource import Resource
 from scim2_models.rfc7643.user import User
@@ -20,7 +22,7 @@ class Sub(ComplexAttribute):
 
 
 class Sup(Resource):
-    schemas: list[str] = ["urn:example:2.0:Sup"]
+    schemas: Annotated[list[str], Required.true] = ["urn:example:2.0:Sup"]
     dummy: str
     sub: Sub
     subs: list[Sub]
@@ -44,7 +46,7 @@ class Baz(ComplexAttribute):
 
 
 class Foo(Resource):
-    schemas: list[str] = ["urn:example:2.0:Foo"]
+    schemas: Annotated[list[str], Required.true] = ["urn:example:2.0:Foo"]
     sub: Annotated[ReturnedModel, Returned.default]
     bar: str
     snake_case: str
@@ -52,15 +54,15 @@ class Foo(Resource):
 
 
 class Bar(Resource):
-    schemas: list[str] = ["urn:example:2.0:Bar"]
+    schemas: Annotated[list[str], Required.true] = ["urn:example:2.0:Bar"]
     sub: Annotated[ReturnedModel, Returned.default]
     bar: str
     snake_case: str
     baz: Optional[Baz] = None
 
 
-class Extension(Resource):
-    schemas: list[str] = ["urn:example:2.0:Extension"]
+class MyExtension(Extension):
+    schemas: Annotated[list[str], Required.true] = ["urn:example:2.0:MyExtension"]
     baz: str
 
 
@@ -105,14 +107,14 @@ def test_validate_attribute_urn():
     )
 
     assert (
-        validate_attribute_urn("urn:example:2.0:Extension:baz", Foo[Extension])
-        == "urn:example:2.0:Extension:baz"
+        validate_attribute_urn("urn:example:2.0:MyExtension:baz", Foo[MyExtension])
+        == "urn:example:2.0:MyExtension:baz"
     )
     assert (
         validate_attribute_urn(
-            "urn:example:2.0:Extension:baz", resource_types=[Foo[Extension]]
+            "urn:example:2.0:MyExtension:baz", resource_types=[Foo[MyExtension]]
         )
-        == "urn:example:2.0:Extension:baz"
+        == "urn:example:2.0:MyExtension:baz"
     )
 
     with pytest.raises(ValueError, match="No default schema and relative URN"):
@@ -299,7 +301,7 @@ def test_dump_after_assignment():
 
 def test_binary_attributes():
     decoded = b"This is a very long line with a lot of characters, enough to create newlines when encoded."
-    encoded = "VGhpcyBpcyBhIHZlcnkgbG9uZyBsaW5lIHdpdGggYSBsb3Qgb2YgY2hhcmFjdGVycywgZW5vdWdo\nIHRvIGNyZWF0ZSBuZXdsaW5lcyB3aGVuIGVuY29kZWQu\n"
+    encoded = "VGhpcyBpcyBhIHZlcnkgbG9uZyBsaW5lIHdpdGggYSBsb3Qgb2YgY2hhcmFjdGVycywgZW5vdWdoIHRvIGNyZWF0ZSBuZXdsaW5lcyB3aGVuIGVuY29kZWQu"
 
     user = User.model_validate(
         {"userName": "foobar", "x509Certificates": [{"value": encoded}]}
@@ -317,7 +319,7 @@ def test_binary_attributes():
     assert user.x509_certificates[0].value == decoded
     assert user.model_dump()["x509Certificates"][0]["value"] == encoded
 
-    encoded_with_padding = "VGhpcyBpcyBhIHZlcnkgbG9uZyBsaW5lIHdpdGggYSBsb3Qgb2YgY2hhcmFjdGVycywgZW5vdWdo\nIHRvIGNyZWF0ZSBuZXdsaW5lcyB3aGVuIGVuY29kZWQu==================\n"
+    encoded_with_padding = "VGhpcyBpcyBhIHZlcnkgbG9uZyBsaW5lIHdpdGggYSBsb3Qgb2YgY2hhcmFjdGVycywgZW5vdWdoIHRvIGNyZWF0ZSBuZXdsaW5lcyB3aGVuIGVuY29kZWQu=================="
     user = User.model_validate(
         {"userName": "foobar", "x509Certificates": [{"value": encoded_with_padding}]}
     )

{scim2_models-0.2.9 → scim2_models-0.2.11}/tests/test_model_serialization.py

@@ -6,6 +6,7 @@ import pytest
 from scim2_models.base import ComplexAttribute
 from scim2_models.base import Context
 from scim2_models.base import Mutability
+from scim2_models.base import Required
 from scim2_models.base import Returned
 from scim2_models.rfc7643.resource import Resource
 
@@ -18,7 +19,7 @@ class SubRetModel(ComplexAttribute):
 
 
 class SupRetResource(Resource):
-    schemas: list[str] = ["org:example:SupRetResource"]
+    schemas: Annotated[list[str], Required.true] = ["org:example:SupRetResource"]
 
     always_returned: Annotated[Optional[str], Returned.always] = None
     never_returned: Annotated[Optional[str], Returned.never] = None
@@ -29,7 +30,7 @@ class SupRetResource(Resource):
 
 
 class MutResource(Resource):
-    schemas: list[str] = ["org:example:MutResource"]
+    schemas: Annotated[list[str], Required.true] = ["org:example:MutResource"]
 
     read_only: Annotated[Optional[str], Mutability.read_only] = None
     read_write: Annotated[Optional[str], Mutability.read_write] = None

{scim2_models-0.2.9 → scim2_models-0.2.11}/tests/test_model_validation.py

@@ -12,7 +12,7 @@ from scim2_models.rfc7643.resource import Resource
 
 
 class RetResource(Resource):
-    schemas: list[str] = ["org:example:RetResource"]
+    schemas: Annotated[list[str], Required.true] = ["org:example:RetResource"]
 
     always_returned: Annotated[Optional[str], Returned.always] = None
     never_returned: Annotated[Optional[str], Returned.never] = None
@@ -21,7 +21,7 @@ class RetResource(Resource):
 
 
 class MutResource(Resource):
-    schemas: list[str] = ["org:example:MutResource"]
+    schemas: Annotated[list[str], Required.true] = ["org:example:MutResource"]
 
     read_only: Annotated[Optional[str], Mutability.read_only] = None
     read_write: Annotated[Optional[str], Mutability.read_write] = None
@@ -30,7 +30,7 @@ class MutResource(Resource):
 
 
 class ReqResource(Resource):
-    schemas: list[str] = ["org:example:ReqResource"]
+    schemas: Annotated[list[str], Required.true] = ["org:example:ReqResource"]
 
     required: Annotated[Optional[str], Required.true] = None
     optional: Annotated[Optional[str], Required.false] = None