scim2-models 0.4.2__tar.gz → 0.5.1__tar.gz

scim2_models-0.5.1/PKG-INFO

@@ -0,0 +1,280 @@
+Metadata-Version: 2.3
+Name: scim2-models
+Version: 0.5.1
+Summary: SCIM2 models serialization and validation with pydantic
+Keywords: scim,scim2,provisioning,pydantic,rfc7643,rfc7644
+Author: Yaal Coop
+Author-email: Yaal Coop <contact@yaal.coop>
+License:                                  Apache License
+                                    Version 2.0, January 2004
+                                 http://www.apache.org/licenses/
+         
+            TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+         
+            1. Definitions.
+         
+               "License" shall mean the terms and conditions for use, reproduction,
+               and distribution as defined by Sections 1 through 9 of this document.
+         
+               "Licensor" shall mean the copyright owner or entity authorized by
+               the copyright owner that is granting the License.
+         
+               "Legal Entity" shall mean the union of the acting entity and all
+               other entities that control, are controlled by, or are under common
+               control with that entity. For the purposes of this definition,
+               "control" means (i) the power, direct or indirect, to cause the
+               direction or management of such entity, whether by contract or
+               otherwise, or (ii) ownership of fifty percent (50%) or more of the
+               outstanding shares, or (iii) beneficial ownership of such entity.
+         
+               "You" (or "Your") shall mean an individual or Legal Entity
+               exercising permissions granted by this License.
+         
+               "Source" form shall mean the preferred form for making modifications,
+               including but not limited to software source code, documentation
+               source, and configuration files.
+         
+               "Object" form shall mean any form resulting from mechanical
+               transformation or translation of a Source form, including but
+               not limited to compiled object code, generated documentation,
+               and conversions to other media types.
+         
+               "Work" shall mean the work of authorship, whether in Source or
+               Object form, made available under the License, as indicated by a
+               copyright notice that is included in or attached to the work
+               (an example is provided in the Appendix below).
+         
+               "Derivative Works" shall mean any work, whether in Source or Object
+               form, that is based on (or derived from) the Work and for which the
+               editorial revisions, annotations, elaborations, or other modifications
+               represent, as a whole, an original work of authorship. For the purposes
+               of this License, Derivative Works shall not include works that remain
+               separable from, or merely link (or bind by name) to the interfaces of,
+               the Work and Derivative Works thereof.
+         
+               "Contribution" shall mean any work of authorship, including
+               the original version of the Work and any modifications or additions
+               to that Work or Derivative Works thereof, that is intentionally
+               submitted to Licensor for inclusion in the Work by the copyright owner
+               or by an individual or Legal Entity authorized to submit on behalf of
+               the copyright owner. For the purposes of this definition, "submitted"
+               means any form of electronic, verbal, or written communication sent
+               to the Licensor or its representatives, including but not limited to
+               communication on electronic mailing lists, source code control systems,
+               and issue tracking systems that are managed by, or on behalf of, the
+               Licensor for the purpose of discussing and improving the Work, but
+               excluding communication that is conspicuously marked or otherwise
+               designated in writing by the copyright owner as "Not a Contribution."
+         
+               "Contributor" shall mean Licensor and any individual or Legal Entity
+               on behalf of whom a Contribution has been received by Licensor and
+               subsequently incorporated within the Work.
+         
+            2. Grant of Copyright License. Subject to the terms and conditions of
+               this License, each Contributor hereby grants to You a perpetual,
+               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+               copyright license to reproduce, prepare Derivative Works of,
+               publicly display, publicly perform, sublicense, and distribute the
+               Work and such Derivative Works in Source or Object form.
+         
+            3. Grant of Patent License. Subject to the terms and conditions of
+               this License, each Contributor hereby grants to You a perpetual,
+               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+               (except as stated in this section) patent license to make, have made,
+               use, offer to sell, sell, import, and otherwise transfer the Work,
+               where such license applies only to those patent claims licensable
+               by such Contributor that are necessarily infringed by their
+               Contribution(s) alone or by combination of their Contribution(s)
+               with the Work to which such Contribution(s) was submitted. If You
+               institute patent litigation against any entity (including a
+               cross-claim or counterclaim in a lawsuit) alleging that the Work
+               or a Contribution incorporated within the Work constitutes direct
+               or contributory patent infringement, then any patent licenses
+               granted to You under this License for that Work shall terminate
+               as of the date such litigation is filed.
+         
+            4. Redistribution. You may reproduce and distribute copies of the
+               Work or Derivative Works thereof in any medium, with or without
+               modifications, and in Source or Object form, provided that You
+               meet the following conditions:
+         
+               (a) You must give any other recipients of the Work or
+                   Derivative Works a copy of this License; and
+         
+               (b) You must cause any modified files to carry prominent notices
+                   stating that You changed the files; and
+         
+               (c) You must retain, in the Source form of any Derivative Works
+                   that You distribute, all copyright, patent, trademark, and
+                   attribution notices from the Source form of the Work,
+                   excluding those notices that do not pertain to any part of
+                   the Derivative Works; and
+         
+               (d) If the Work includes a "NOTICE" text file as part of its
+                   distribution, then any Derivative Works that You distribute must
+                   include a readable copy of the attribution notices contained
+                   within such NOTICE file, excluding those notices that do not
+                   pertain to any part of the Derivative Works, in at least one
+                   of the following places: within a NOTICE text file distributed
+                   as part of the Derivative Works; within the Source form or
+                   documentation, if provided along with the Derivative Works; or,
+                   within a display generated by the Derivative Works, if and
+                   wherever such third-party notices normally appear. The contents
+                   of the NOTICE file are for informational purposes only and
+                   do not modify the License. You may add Your own attribution
+                   notices within Derivative Works that You distribute, alongside
+                   or as an addendum to the NOTICE text from the Work, provided
+                   that such additional attribution notices cannot be construed
+                   as modifying the License.
+         
+               You may add Your own copyright statement to Your modifications and
+               may provide additional or different license terms and conditions
+               for use, reproduction, or distribution of Your modifications, or
+               for any such Derivative Works as a whole, provided Your use,
+               reproduction, and distribution of the Work otherwise complies with
+               the conditions stated in this License.
+         
+            5. Submission of Contributions. Unless You explicitly state otherwise,
+               any Contribution intentionally submitted for inclusion in the Work
+               by You to the Licensor shall be under the terms and conditions of
+               this License, without any additional terms or conditions.
+               Notwithstanding the above, nothing herein shall supersede or modify
+               the terms of any separate license agreement you may have executed
+               with Licensor regarding such Contributions.
+         
+            6. Trademarks. This License does not grant permission to use the trade
+               names, trademarks, service marks, or product names of the Licensor,
+               except as required for reasonable and customary use in describing the
+               origin of the Work and reproducing the content of the NOTICE file.
+         
+            7. Disclaimer of Warranty. Unless required by applicable law or
+               agreed to in writing, Licensor provides the Work (and each
+               Contributor provides its Contributions) on an "AS IS" BASIS,
+               WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+               implied, including, without limitation, any warranties or conditions
+               of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+               PARTICULAR PURPOSE. You are solely responsible for determining the
+               appropriateness of using or redistributing the Work and assume any
+               risks associated with Your exercise of permissions under this License.
+         
+            8. Limitation of Liability. In no event and under no legal theory,
+               whether in tort (including negligence), contract, or otherwise,
+               unless required by applicable law (such as deliberate and grossly
+               negligent acts) or agreed to in writing, shall any Contributor be
+               liable to You for damages, including any direct, indirect, special,
+               incidental, or consequential damages of any character arising as a
+               result of this License or out of the use or inability to use the
+               Work (including but not limited to damages for loss of goodwill,
+               work stoppage, computer failure or malfunction, or any and all
+               other commercial damages or losses), even if such Contributor
+               has been advised of the possibility of such damages.
+         
+            9. Accepting Warranty or Additional Liability. While redistributing
+               the Work or Derivative Works thereof, You may choose to offer,
+               and charge a fee for, acceptance of support, warranty, indemnity,
+               or other liability obligations and/or rights consistent with this
+               License. However, in accepting such obligations, You may act only
+               on Your own behalf and on Your sole responsibility, not on behalf
+               of any other Contributor, and only if You agree to indemnify,
+               defend, and hold each Contributor harmless for any liability
+               incurred by, or claims asserted against, such Contributor by reason
+               of your accepting any such warranty or additional liability.
+         
+            END OF TERMS AND CONDITIONS
+         
+            APPENDIX: How to apply the Apache License to your work.
+         
+               To apply the Apache License to your work, attach the following
+               boilerplate notice, with the fields enclosed by brackets "[]"
+               replaced with your own identifying information. (Don't include
+               the brackets!)  The text should be enclosed in the appropriate
+               comment syntax for the file format. We also recommend that a
+               file or class name and description of purpose be included on the
+               same "printed page" as the copyright notice for easier
+               identification within third-party archives.
+         
+            Copyright [yyyy] [name of copyright owner]
+         
+            Licensed under the Apache License, Version 2.0 (the "License");
+            you may not use this file except in compliance with the License.
+            You may obtain a copy of the License at
+         
+                http://www.apache.org/licenses/LICENSE-2.0
+         
+            Unless required by applicable law or agreed to in writing, software
+            distributed under the License is distributed on an "AS IS" BASIS,
+            WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+            See the License for the specific language governing permissions and
+            limitations under the License.
+Classifier: Intended Audience :: Developers
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Environment :: Web Environment
+Classifier: Programming Language :: Python
+Classifier: Operating System :: OS Independent
+Requires-Dist: pydantic[email]>=2.7.0
+Requires-Python: >=3.10
+Project-URL: changelog, https://scim2-models.readthedocs.io/en/latest/changelog.html
+Project-URL: documentation, https://scim2-models.readthedocs.io
+Project-URL: funding, https://github.com/sponsors/python-scim
+Project-URL: repository, https://github.com/python-scim/scim2-models
+Description-Content-Type: text/markdown
+
+# scim2-models
+
+[Pydantic](https://docs.pydantic.dev) models for SCIM schemas defined in [RFC7643](https://datatracker.ietf.org/doc/html/rfc7643.html) and [RFC7644](https://datatracker.ietf.org/doc/html/rfc7644.html).
+
+This library provides utilities to parse and produce SCIM2 payloads, and handle them with native Python objects.
+It aims to be used as a basis to build SCIM2 servers and clients.
+
+## What's SCIM anyway?
+
+SCIM stands for System for Cross-domain Identity Management, and it is a provisioning protocol.
+Provisioning is the action of managing a set of resources across different services, usually users and groups.
+SCIM is often used between Identity Providers and applications in completion of standards like OAuth2 and OpenID Connect.
+It allows users and groups creations, modifications and deletions to be synchronized between applications.
+
+## Installation
+
+```shell
+pip install scim2-models
+```
+
+## Usage
+
+Check the [tutorial](https://scim2-models.readthedocs.io/en/latest/tutorial.html) and the [reference](https://scim2-models.readthedocs.io/en/latest/reference.html) for more details.
+
+```python
+from scim2_models import User
+import datetime
+
+payload = {
+    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
+    "id": "2819c223-7f76-453a-919d-413861904646",
+    "userName": "bjensen@example.com",
+    "meta": {
+        "resourceType": "User",
+        "created": "2010-01-23T04:56:22Z",
+        "lastModified": "2011-05-13T04:42:34Z",
+        "version": 'W\\/"3694e05e9dff590"',
+        "location": "https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646",
+    },
+}
+
+user = User.model_validate(payload)
+assert user.user_name == "bjensen@example.com"
+assert user.meta.created == datetime.datetime(
+    2010, 1, 23, 4, 56, 22, tzinfo=datetime.timezone.utc
+)
+```
+
+scim2-models belongs in a collection of SCIM tools developed by [Yaal Coop](https://yaal.coop),
+with [scim2-client](https://github.com/python-scim/scim2-client),
+[scim2-tester](https://github.com/python-scim/scim2-tester) and
+[scim2-cli](https://github.com/python-scim/scim2-cli)

{scim2_models-0.4.2 → scim2_models-0.5.1}/pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
+requires = ["uv_build>=0.8.9,<0.9.0"]
+build-backend = "uv_build"
 
 [project]
 name = "scim2-models"
-version = "0.4.2"
+version = "0.5.1"
 description = "SCIM2 models serialization and validation with pydantic"
 authors = [{name="Yaal Coop", email="contact@yaal.coop"}]
 license = {file = "LICENSE"}
@@ -25,7 +25,7 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 
-requires-python = ">= 3.9"
+requires-python = ">= 3.10"
 dependencies = [
     "pydantic[email]>=2.7.0"
 ]
@@ -36,12 +36,15 @@ repository = "https://github.com/python-scim/scim2-models"
 changelog = "https://scim2-models.readthedocs.io/en/latest/changelog.html"
 funding = "https://github.com/sponsors/python-scim"
 
+[tool.uv.build-backend]
+module-root = ""
+
 [dependency-groups]
 dev = [
     "mypy>=1.13.0",
     "pytest>=8.2.1",
     "pytest-cov>=6.0.0",
-    "pre-commit-uv>=4.1.4",
+    "prek>=0.1.0",
     "tox-uv>=1.16.0",
 ]
 doc = [
@@ -125,11 +128,11 @@ warn_required_dynamic_aliases = true
 requires = ["tox>=4.19"]
 env_list = [
     "style",
-    "py39",
     "py310",
     "py311",
     "py312",
     "py313",
+    "py314",
     "minversions",
     "doc",
     "coverage",
@@ -146,12 +149,13 @@ commands = [
 skip_install = true
 runner = "uv-venv-runner"
 commands = [
-    ["pre-commit", "run", "--all-files", "--show-diff-on-failure"],
+    ["prek", "run", "--all-files", "--show-diff-on-failure"],
 ]
 
 [tool.tox.env.minversions]
 runner = "uv-venv-runner"
 uv_resolution = "lowest-direct"
+base_python = ["3.10"]
 
 [tool.tox.env.doc]
 dependency_groups = ["doc"]

{scim2_models-0.4.2 → scim2_models-0.5.1}/scim2_models/attributes.py

@@ -1,7 +1,6 @@
 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
@@ -16,7 +15,7 @@ from .reference import Reference
 class ComplexAttribute(BaseModel):
     """A complex attribute as defined in :rfc:`RFC7643 §2.3.8 <7643#section-2.3.8>`."""
 
-    _attribute_urn: Optional[str] = None
+    _attribute_urn: str | None = None
 
     def get_attribute_urn(self, field_name: str) -> str:
         """Build the full URN of the attribute.
@@ -30,20 +29,20 @@ class ComplexAttribute(BaseModel):
 
 
 class MultiValuedComplexAttribute(ComplexAttribute):
-    type: Optional[str] = None
+    type: str | None = None
     """A label indicating the attribute's function."""
 
-    primary: Optional[bool] = None
+    primary: bool | None = None
     """A Boolean value indicating the 'primary' or preferred attribute value
     for this attribute."""
 
-    display: Annotated[Optional[str], Mutability.immutable] = None
+    display: Annotated[str | None, Mutability.immutable] = None
     """A human-readable name, primarily used for display purposes."""
 
-    value: Optional[Any] = None
+    value: Any | None = None
     """The value of an entitlement."""
 
-    ref: Optional[Reference[Any]] = Field(None, serialization_alias="$ref")
+    ref: Reference[Any] | None = Field(None, serialization_alias="$ref")
     """The reference URI of a target resource, if the attribute is a
     reference."""
 
@@ -53,5 +52,5 @@ def is_complex_attribute(type_: type) -> bool:
     return (
         get_origin(type_) != Reference
         and isclass(type_)
-        and issubclass(type_, (ComplexAttribute, MultiValuedComplexAttribute))
+        and issubclass(type_, ComplexAttribute)
     )

{scim2_models-0.4.2 → scim2_models-0.5.1}/scim2_models/base.py

@@ -96,7 +96,7 @@ class BaseModel(PydanticBaseModel):
         return field_annotation
 
     @classmethod
-    def get_field_root_type(cls, attribute_name: str) -> Optional[type]:
+    def get_field_root_type(cls, attribute_name: str) -> type | None:
         """Extract the root type from a model field.
 
         This method unwraps complex type annotations to find the underlying
@@ -244,7 +244,7 @@ class BaseModel(PydanticBaseModel):
             return result
 
         def normalize_value(
-            val: Any, model_class: Optional[type["BaseModel"]] = None
+            val: Any, model_class: type["BaseModel"] | None = None
         ) -> Any:
             """Normalize input value based on model class."""
             if not isinstance(val, dict):
@@ -504,7 +504,7 @@ class BaseModel(PydanticBaseModel):
     def model_validate(
         cls,
         *args: Any,
-        scim_ctx: Optional[Context] = Context.DEFAULT,
+        scim_ctx: Context | None = Context.DEFAULT,
         original: Optional["BaseModel"] = None,
         **kwargs: Any,
     ) -> Self:

{scim2_models-0.4.2 → scim2_models-0.5.1}/scim2_models/messages/bulk.py

@@ -1,7 +1,6 @@
 from enum import Enum
 from typing import Annotated
 from typing import Any
-from typing import Optional
 
 from pydantic import Field
 from pydantic import PlainSerializer
@@ -19,30 +18,30 @@ class BulkOperation(ComplexAttribute):
         patch = "PATCH"
         delete = "DELETE"
 
-    method: Optional[Method] = None
+    method: Method | None = None
     """The HTTP method of the current operation."""
 
-    bulk_id: Optional[str] = None
+    bulk_id: str | None = None
     """The transient identifier of a newly created resource, unique within a
     bulk request and created by the client."""
 
-    version: Optional[str] = None
+    version: str | None = None
     """The current resource version."""
 
-    path: Optional[str] = None
+    path: str | None = None
     """The resource's relative path to the SCIM service provider's root."""
 
-    data: Optional[Any] = None
+    data: Any | None = None
     """The resource data as it would appear for a single SCIM POST, PUT, or
     PATCH operation."""
 
-    location: Optional[str] = None
+    location: str | None = None
     """The resource endpoint URL."""
 
-    response: Optional[Any] = None
+    response: Any | None = None
     """The HTTP response body for the specified request operation."""
 
-    status: Annotated[Optional[int], PlainSerializer(_int_to_str)] = None
+    status: Annotated[int | None, PlainSerializer(_int_to_str)] = None
     """The HTTP response status code for the requested operation."""
 
 
@@ -58,12 +57,12 @@ class BulkRequest(Message):
         "urn:ietf:params:scim:api:messages:2.0:BulkRequest"
     ]
 
-    fail_on_errors: Optional[int] = None
+    fail_on_errors: int | None = None
     """An integer specifying the number of errors that the service provider
     will accept before the operation is terminated and an error response is
     returned."""
 
-    operations: Optional[list[BulkOperation]] = Field(
+    operations: list[BulkOperation] | None = Field(
         None, serialization_alias="Operations"
     )
     """Defines operations within a bulk job."""
@@ -81,7 +80,7 @@ class BulkResponse(Message):
         "urn:ietf:params:scim:api:messages:2.0:BulkResponse"
     ]
 
-    operations: Optional[list[BulkOperation]] = Field(
+    operations: list[BulkOperation] | None = Field(
         None, serialization_alias="Operations"
     )
     """Defines operations within a bulk job."""

{scim2_models-0.4.2 → scim2_models-0.5.1}/scim2_models/messages/error.py

@@ -1,5 +1,4 @@
 from typing import Annotated
-from typing import Optional
 
 from pydantic import PlainSerializer
 
@@ -15,14 +14,14 @@ class Error(Message):
         "urn:ietf:params:scim:api:messages:2.0:Error"
     ]
 
-    status: Annotated[Optional[int], PlainSerializer(_int_to_str)] = None
+    status: Annotated[int | None, PlainSerializer(_int_to_str)] = None
     """The HTTP status code (see Section 6 of [RFC7231]) expressed as a JSON
     string."""
 
-    scim_type: Optional[str] = None
+    scim_type: str | None = None
     """A SCIM detail error keyword."""
 
-    detail: Optional[str] = None
+    detail: str | None = None
     """A detailed human-readable message."""
 
     @classmethod

{scim2_models-0.4.2 → scim2_models-0.5.1}/scim2_models/messages/list_response.py

@@ -1,7 +1,6 @@
 from typing import Annotated
 from typing import Any
 from typing import Generic
-from typing import Optional
 
 from pydantic import Field
 from pydantic import ValidationInfo
@@ -22,19 +21,17 @@ class ListResponse(Message, Generic[AnyResource], metaclass=_GenericMessageMetac
         "urn:ietf:params:scim:api:messages:2.0:ListResponse"
     ]
 
-    total_results: Optional[int] = None
+    total_results: int | None = None
     """The total number of results returned by the list or query operation."""
 
-    start_index: Optional[int] = None
+    start_index: int | None = None
     """The 1-based index of the first result in the current set of list
     results."""
 
-    items_per_page: Optional[int] = None
+    items_per_page: int | None = None
     """The number of resources returned in a list response page."""
 
-    resources: Optional[list[AnyResource]] = Field(
-        None, serialization_alias="Resources"
-    )
+    resources: list[AnyResource] | None = Field(None, serialization_alias="Resources")
     """A multi-valued list of complex objects containing the requested
     resources."""
 

{scim2_models-0.4.2 → scim2_models-0.5.1}/scim2_models/messages/message.py

@@ -1,7 +1,6 @@
+from collections.abc import Callable
 from typing import Annotated
 from typing import Any
-from typing import Callable
-from typing import Optional
 from typing import Union
 from typing import get_args
 from typing import get_origin
@@ -23,14 +22,14 @@ class Message(ScimObject):
 
 def _create_schema_discriminator(
     resource_types_schemas: list[str],
-) -> Callable[[Any], Optional[str]]:
+) -> Callable[[Any], str | None]:
     """Create a schema discriminator function for the given resource schemas.
 
     :param resource_types_schemas: List of valid resource schemas
     :return: Discriminator function for Pydantic
     """
 
-    def get_schema_from_payload(payload: Any) -> Optional[str]:
+    def get_schema_from_payload(payload: Any) -> str | None:
         """Extract schema from SCIM payload for discrimination.
 
         :param payload: SCIM payload dict or object
@@ -89,7 +88,7 @@ def _create_tagged_resource_union(resource_union: Any) -> Any:
         for resource_type in resource_types
     ]
     # Dynamic union construction from tuple - MyPy can't validate this at compile time
-    union = Union[tuple(tagged_resources)]  # type: ignore
+    union = Union[tuple(tagged_resources)]  # type: ignore  # noqa: UP007
     return Annotated[union, discriminator]