scim2-models 0.3.0__tar.gz → 0.3.2__tar.gz

{scim2_models-0.3.0 → scim2_models-0.3.2}/.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 ---
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.8.2'
+    rev: 'v0.11.2'
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
@@ -16,11 +16,11 @@ repos:
         exclude: "\\.svg$|\\.map$|\\.min\\.css$|\\.min\\.js$|\\.po$|\\.pot$"
       - id: check-toml
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.13.0
+    rev: v1.15.0
     hooks:
       - id: mypy
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
+    rev: v2.4.1
     hooks:
     - id: codespell
       additional_dependencies:

{scim2_models-0.3.0 → scim2_models-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: scim2-models
-Version: 0.3.0
+Version: 0.3.2
 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
@@ -208,6 +208,7 @@ License:                                  Apache License
            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.
+License-File: LICENSE
 Keywords: provisioning,pydantic,rfc7643,rfc7644,scim,scim2
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Web Environment

{scim2_models-0.3.0 → scim2_models-0.3.2}/doc/changelog.rst

@@ -1,6 +1,21 @@
 Changelog
 =========
 
+[0.3.2] - 2025-03-28
+--------------------
+
+Fixed
+^^^^^
+- Pydantic warning.
+
+[0.3.1] - 2025-03-07
+--------------------
+
+Fixed
+^^^^^
+- Fix :attr:`~scim2_models.SearchRequest.start_index` and :attr:`~scim2_models.SearchRequest.count` limits. :issue:`84`
+- :attr:`~scim2_models.ListResponse.total_resuls` is required. :issue:`88`
+
 [0.3.0] - 2024-12-11
 --------------------
 

{scim2_models-0.3.0 → scim2_models-0.3.2}/pyproject.toml

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

{scim2_models-0.3.0 → scim2_models-0.3.2}/scim2_models/base.py

@@ -649,14 +649,14 @@ class BaseModel(PydanticBaseModel):
         """
         from scim2_models.rfc7643.resource import Resource
 
-        for field_name in self.model_fields:
+        for field_name in self.__class__.model_fields:
             attr_type = self.get_field_root_type(field_name)
             if not is_complex_attribute(attr_type):
                 continue
 
             main_schema = (
                 getattr(self, "_schema", None)
-                or self.model_fields["schemas"].default[0]
+                or self.__class__.model_fields["schemas"].default[0]
             )
 
             separator = ":" if isinstance(self, Resource) else "."
@@ -847,8 +847,10 @@ class BaseModel(PydanticBaseModel):
 
         See :rfc:`RFC7644 §3.10 <7644#section-3.10>`.
         """
-        main_schema = self.model_fields["schemas"].default[0]
-        alias = self.model_fields[field_name].serialization_alias or field_name
+        main_schema = self.__class__.model_fields["schemas"].default[0]
+        alias = (
+            self.__class__.model_fields[field_name].serialization_alias or field_name
+        )
 
         # if alias contains a ':' this is an extension urn
         full_urn = alias if ":" in alias else f"{main_schema}:{alias}"
@@ -865,7 +867,9 @@ class ComplexAttribute(BaseModel):
 
         See :rfc:`RFC7644 §3.10 <7644#section-3.10>`.
         """
-        alias = self.model_fields[field_name].serialization_alias or field_name
+        alias = (
+            self.__class__.model_fields[field_name].serialization_alias or field_name
+        )
         return f"{self._schema}.{alias}"
 
 

{scim2_models-0.3.0 → scim2_models-0.3.2}/scim2_models/rfc7643/schema.py

@@ -3,7 +3,7 @@ from datetime import datetime
 from enum import Enum
 from typing import Annotated
 from typing import Any
-from typing import List  # noqa : UP005
+from typing import List  # noqa : UP005,UP035
 from typing import Literal
 from typing import Optional
 from typing import Union

{scim2_models-0.3.0 → scim2_models-0.3.2}/scim2_models/rfc7644/list_response.py

@@ -104,7 +104,13 @@ class ListResponse(Message, Generic[AnyResource], metaclass=ListResponseMetaclas
     def check_results_number(
         cls, value: Any, handler: ValidatorFunctionWrapHandler, info: ValidationInfo
     ) -> Self:
-        """:rfc:`RFC7644 §3.4.2 <7644#section-3.4.2.4>` indicates that 'resources' must be set if 'totalResults' is non-zero."""
+        """Validate result numbers.
+
+        :rfc:`RFC7644 §3.4.2 <7644#section-3.4.2.4>` indicates that:
+
+        - 'totalResults' is required
+        - 'resources' must be set if 'totalResults' is non-zero.
+        """
         obj = handler(value)
 
         if (
@@ -114,6 +120,12 @@ class ListResponse(Message, Generic[AnyResource], metaclass=ListResponseMetaclas
         ):
             return obj
 
+        if obj.total_results is None:
+            raise PydanticCustomError(
+                "required_error",
+                "Field 'total_results' is required but value is missing or null",
+            )
+
         if obj.total_results > 0 and not obj.resources:
             raise PydanticCustomError(
                 "no_resource_error",

{scim2_models-0.3.0 → scim2_models-0.3.2}/scim2_models/rfc7644/search_request.py

@@ -49,11 +49,11 @@ class SearchRequest(Message):
     @field_validator("start_index")
     @classmethod
     def start_index_floor(cls, value: int) -> int:
-        """According to :rfc:`RFC7644 §3.4.2 <7644#section-3.4.2.4>, start_index values less than 0 are interpreted as 0.
+        """According to :rfc:`RFC7644 §3.4.2 <7644#section-3.4.2.4>, start_index values less than 1 are interpreted as 1.
 
         A value less than 1 SHALL be interpreted as 1.
         """
-        return None if value is None else max(0, value)
+        return None if value is None else max(1, value)
 
     count: Optional[int] = None
     """An integer indicating the desired maximum number of query results per
@@ -62,11 +62,11 @@ class SearchRequest(Message):
     @field_validator("count")
     @classmethod
     def count_floor(cls, value: int) -> int:
-        """According to :rfc:`RFC7644 §3.4.2 <7644#section-3.4.2.4>, count values less than 1 are interpreted as 1.
+        """According to :rfc:`RFC7644 §3.4.2 <7644#section-3.4.2.4>, count values less than 0 are interpreted as 0.
 
-        A value less than 1 SHALL be interpreted as 1.
+        A negative value SHALL be interpreted as 0.
         """
-        return None if value is None else max(1, value)
+        return None if value is None else max(0, value)
 
     @model_validator(mode="after")
     def attributes_validator(self):

{scim2_models-0.3.0 → scim2_models-0.3.2}/tests/test_dynamic_resources.py

@@ -2720,7 +2720,7 @@ def test_make_schema_model_from_schema(load_sample):
     assert obj.attributes[0].type == "string"
     assert not obj.attributes[0].multi_valued
     assert obj.attributes[0].description == (
-        "A human-readable name for the Group. " "REQUIRED."
+        "A human-readable name for the Group. REQUIRED."
     )
     assert not obj.attributes[0].required
     assert not obj.attributes[0].case_exact
@@ -2749,7 +2749,7 @@ def test_make_schema_model_from_schema(load_sample):
     assert obj.attributes[1].sub_attributes[1].reference_types == ["User", "Group"]
     assert not obj.attributes[1].sub_attributes[1].multi_valued
     assert obj.attributes[1].sub_attributes[1].description == (
-        "The URI corresponding to a SCIM resource " "that is a member of this Group."
+        "The URI corresponding to a SCIM resource that is a member of this Group."
     )
     assert not obj.attributes[1].sub_attributes[1].required
     assert not obj.attributes[1].sub_attributes[1].case_exact
@@ -2760,7 +2760,7 @@ def test_make_schema_model_from_schema(load_sample):
     assert obj.attributes[1].sub_attributes[2].type == "string"
     assert not obj.attributes[1].sub_attributes[2].multi_valued
     assert obj.attributes[1].sub_attributes[2].description == (
-        "A label indicating the type of resource, " "e.g., 'User' or 'Group'."
+        "A label indicating the type of resource, e.g., 'User' or 'Group'."
     )
     assert not obj.attributes[1].sub_attributes[2].required
     assert not obj.attributes[1].sub_attributes[2].case_exact

{scim2_models-0.3.0 → scim2_models-0.3.2}/tests/test_list_response.py

@@ -217,3 +217,26 @@ def test_list_response_schema_ordering():
         ],
     }
     ListResponse[Union[User[EnterpriseUser], Group]].model_validate(payload)
+
+
+def test_total_results_required():
+    """ListResponse.total_results is required."""
+    payload = {
+        "Resources": [
+            {
+                "schemas": [
+                    "urn:ietf:params:scim:schemas:core:2.0:User",
+                ],
+                "userName": "bjensen@example.com",
+                "id": "foobar",
+            }
+        ],
+    }
+
+    with pytest.raises(
+        ValidationError,
+        match="Field 'total_results' is required but value is missing or null",
+    ):
+        ListResponse[User].model_validate(
+            payload, scim_ctx=Context.RESOURCE_QUERY_RESPONSE
+        )

{scim2_models-0.3.0 → scim2_models-0.3.2}/tests/test_schema.py

@@ -19,7 +19,7 @@ def test_group_schema(load_sample):
     assert obj.attributes[0].type == Attribute.Type.string
     assert not obj.attributes[0].multi_valued
     assert obj.attributes[0].description == (
-        "A human-readable name for the Group. " "REQUIRED."
+        "A human-readable name for the Group. REQUIRED."
     )
     assert not obj.attributes[0].required
     assert not obj.attributes[0].case_exact
@@ -48,7 +48,7 @@ def test_group_schema(load_sample):
     assert obj.attributes[1].sub_attributes[1].reference_types == ["User", "Group"]
     assert not obj.attributes[1].sub_attributes[1].multi_valued
     assert obj.attributes[1].sub_attributes[1].description == (
-        "The URI corresponding to a SCIM resource " "that is a member of this Group."
+        "The URI corresponding to a SCIM resource that is a member of this Group."
     )
     assert not obj.attributes[1].sub_attributes[1].required
     assert not obj.attributes[1].sub_attributes[1].case_exact
@@ -59,7 +59,7 @@ def test_group_schema(load_sample):
     assert obj.attributes[1].sub_attributes[2].type == Attribute.Type.string
     assert not obj.attributes[1].sub_attributes[2].multi_valued
     assert obj.attributes[1].sub_attributes[2].description == (
-        "A label indicating the type of resource, " "e.g., 'User' or 'Group'."
+        "A label indicating the type of resource, e.g., 'User' or 'Group'."
     )
     assert not obj.attributes[1].sub_attributes[2].required
     assert not obj.attributes[1].sub_attributes[2].case_exact

{scim2_models-0.3.0 → scim2_models-0.3.2}/tests/test_search_request.py

@@ -29,13 +29,13 @@ def test_start_index_floor():
 
     https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.4
 
-        A negative value SHALL be interpreted as 0.
+        A value less than 1 SHALL be interpreted as 1.
     """
     sr = SearchRequest(start_index=100)
     assert sr.start_index == 100
 
-    sr = SearchRequest(start_index=-1)
-    assert sr.start_index == 0
+    sr = SearchRequest(start_index=0)
+    assert sr.start_index == 1
 
 
 def test_count_floor():
@@ -43,16 +43,13 @@ def test_count_floor():
 
     https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.4
 
-        A value less than 1 SHALL be interpreted as 1.
+        A negative value SHALL be interpreted as 0.
     """
     sr = SearchRequest(count=100)
     assert sr.count == 100
 
-    sr = SearchRequest(count=0)
-    assert sr.count == 1
-
     sr = SearchRequest(count=-1)
-    assert sr.count == 1
+    assert sr.count == 0
 
 
 def test_attributes_or_excluded_attributes():