feat: replace check_status_code parameter by expected_status_codes.

Author: azmeuk

doc/changelog.rst

@@ -1,11 +1,18 @@
 Changelog
 =========
 
+[0.2.0] - Unreleased
+---------------------
+
+Added
+^^^^^
+- Replace :code:`check_status_code` parameter by :code:`expected_status_codes`.
+
 [0.1.11] - 2024-08-31
 ---------------------
 
 Fixed
-^^^^^^^
+^^^^^
 - Support for content-types with charset information. #18 #19
 
 [0.1.10] - 2024-08-18

doc/tutorial.rst

@@ -68,8 +68,9 @@ To achieve this, all the methods provide the following parameters, all are :data
 - :code:`check_response_payload`:
   If :data:`True` a :class:`~pydantic.ValidationError` will be raised if the server response does not respect the SCIM standard.
   If :data:`False` the server response is returned as-is.
-- :code:`check_status_code`: Whether to validate that the response status code is valid.
-  If :data:`True` and an unexpected status code is returned, a :class:`~scim2_client.errors.UnexpectedStatusCode` exception is raised.
+- :code:`expected_status_codes`: The list of expected status codes in the response.
+  If :data:`None` any status code is accepted.
+  If an unexpected status code is returned, a :class:`~scim2_client.errors.UnexpectedStatusCode` exception is raised.
 - :code:`raise_scim_errors`: If :data:`True` and the server returned an :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject` exception will be raised.
   If :data:`False` the error object is returned.
 

scim2_client/client.py

@@ -240,7 +240,7 @@ def create(
         resource: Union[AnyResource, Dict],
         check_request_payload: bool = True,
         check_response_payload: bool = True,
-        check_status_code: bool = True,
+        expected_status_codes: Optional[List[int]] = CREATION_RESPONSE_STATUS_CODES,
         raise_scim_errors: bool = False,
         **kwargs,
     ) -> Union[AnyResource, Error, Dict]:
@@ -253,7 +253,8 @@ def create(
             :code:`resource` is expected to be a dict that will be passed as-is in the request.
         :param check_response_payload: Whether to validate that the response payload is valid.
             If set, the raw payload will be returned.
-        :param check_status_code: Whether to validate that the response status code is valid.
+        :param expected_status_codes: The list of expected status codes form the response.
+            If :data:`None` any status code is accepted.
         :param raise_scim_errors: If :data:`True` and the server returned an
             :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
             exception will be raised. If :data:`False` the error object is returned.
@@ -318,9 +319,7 @@ def create(
 
         return self.check_response(
             response=response,
-            expected_status_codes=(
-                self.CREATION_RESPONSE_STATUS_CODES if check_status_code else None
-            ),
+            expected_status_codes=expected_status_codes,
             expected_types=([resource.__class__] if check_request_payload else None),
             check_response_payload=check_response_payload,
             raise_scim_errors=raise_scim_errors,
@@ -334,7 +333,7 @@ def query(
         search_request: Optional[Union[SearchRequest, Dict]] = None,
         check_request_payload: bool = True,
         check_response_payload: bool = True,
-        check_status_code: bool = True,
+        expected_status_codes: Optional[List[int]] = QUERY_RESPONSE_STATUS_CODES,
         raise_scim_errors: bool = False,
         **kwargs,
     ) -> Union[AnyResource, ListResponse[AnyResource], Error, Dict]:
@@ -351,7 +350,8 @@ def query(
             :code:`search_request` is expected to be a dict that will be passed as-is in the request.
         :param check_response_payload: Whether to validate that the response payload is valid.
             If set, the raw payload will be returned.
-        :param check_status_code: Whether to validate that the response status code is valid.
+        :param expected_status_codes: The list of expected status codes form the response.
+            If :data:`None` any status code is accepted.
         :param raise_scim_errors: If :data:`True` and the server returned an
             :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
             exception will be raised. If :data:`False` the error object is returned.
@@ -447,9 +447,7 @@ def query(
 
         return self.check_response(
             response=response,
-            expected_status_codes=(
-                self.QUERY_RESPONSE_STATUS_CODES if check_status_code else None
-            ),
+            expected_status_codes=expected_status_codes,
             expected_types=expected_types,
             check_response_payload=check_response_payload,
             raise_scim_errors=raise_scim_errors,
@@ -461,7 +459,7 @@ def search(
         search_request: Optional[SearchRequest] = None,
         check_request_payload: bool = True,
         check_response_payload: bool = True,
-        check_status_code: bool = True,
+        expected_status_codes: Optional[List[int]] = SEARCH_RESPONSE_STATUS_CODES,
         raise_scim_errors: bool = False,
         **kwargs,
     ) -> Union[AnyResource, ListResponse[AnyResource], Error, Dict]:
@@ -475,7 +473,8 @@ def search(
             :code:`search_request` is expected to be a dict that will be passed as-is in the request.
         :param check_response_payload: Whether to validate that the response payload is valid.
             If set, the raw payload will be returned.
-        :param check_status_code: Whether to validate that the response status code is valid.
+        :param expected_status_codes: The list of expected status codes form the response.
+            If :data:`None` any status code is accepted.
         :param raise_scim_errors: If :data:`True` and the server returned an
             :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
             exception will be raised. If :data:`False` the error object is returned.
@@ -528,9 +527,7 @@ def search(
 
         return self.check_response(
             response=response,
-            expected_status_codes=(
-                self.SEARCH_RESPONSE_STATUS_CODES if check_status_code else None
-            ),
+            expected_status_codes=expected_status_codes,
             expected_types=[ListResponse[Union[self.resource_types]]],
             check_response_payload=check_response_payload,
             raise_scim_errors=raise_scim_errors,
@@ -542,7 +539,7 @@ def delete(
         resource_type: Type,
         id: str,
         check_response_payload: bool = True,
-        check_status_code: bool = True,
+        expected_status_codes: Optional[List[int]] = DELETION_RESPONSE_STATUS_CODES,
         raise_scim_errors: bool = False,
         **kwargs,
     ) -> Optional[Union[Error, Dict]]:
@@ -553,7 +550,8 @@ def delete(
         :param id: The type id the resource to delete.
         :param check_response_payload: Whether to validate that the response payload is valid.
             If set, the raw payload will be returned.
-        :param check_status_code: Whether to validate that the response status code is valid.
+        :param expected_status_codes: The list of expected status codes form the response.
+            If :data:`None` any status code is accepted.
         :param raise_scim_errors: If :data:`True` and the server returned an
             :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
             exception will be raised. If :data:`False` the error object is returned.
@@ -588,9 +586,7 @@ def delete(
 
         return self.check_response(
             response=response,
-            expected_status_codes=(
-                self.DELETION_RESPONSE_STATUS_CODES if check_status_code else None
-            ),
+            expected_status_codes=expected_status_codes,
             check_response_payload=check_response_payload,
             raise_scim_errors=raise_scim_errors,
         )
@@ -600,7 +596,7 @@ def replace(
         resource: Union[AnyResource, Dict],
         check_request_payload: bool = True,
         check_response_payload: bool = True,
-        check_status_code: bool = True,
+        expected_status_codes: Optional[List[int]] = REPLACEMENT_RESPONSE_STATUS_CODES,
         raise_scim_errors: bool = False,
         **kwargs,
     ) -> Union[AnyResource, Error, Dict]:
@@ -613,7 +609,8 @@ def replace(
             :code:`resource` is expected to be a dict that will be passed as-is in the request.
         :param check_response_payload: Whether to validate that the response payload is valid.
             If set, the raw payload will be returned.
-        :param check_status_code: Whether to validate that the response status code is valid.
+        :param expected_status_codes: The list of expected status codes form the response.
+            If :data:`None` any status code is accepted.
         :param raise_scim_errors: If :data:`True` and the server returned an
             :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
             exception will be raised. If :data:`False` the error object is returned.
@@ -687,9 +684,7 @@ def replace(
 
         return self.check_response(
             response=response,
-            expected_status_codes=(
-                self.REPLACEMENT_RESPONSE_STATUS_CODES if check_status_code else None
-            ),
+            expected_status_codes=expected_status_codes,
             expected_types=([resource.__class__] if check_request_payload else None),
             check_response_payload=check_response_payload,
             raise_scim_errors=raise_scim_errors,

tests/test_create.py

@@ -244,7 +244,8 @@ def test_no_200(httpserver):
     scim_client = SCIMClient(client, resource_types=(User,))
     with pytest.raises(UnexpectedStatusCode):
         scim_client.create(user_request)
-    scim_client.create(user_request, check_status_code=False)
+    scim_client.create(user_request, expected_status_codes=None)
+    scim_client.create(user_request, expected_status_codes=[200, 201])
 
 
 @pytest.mark.parametrize("code", [400, 401, 403, 404, 500])

tests/test_query.py

@@ -532,7 +532,7 @@ def test_response_bad_status_code(client):
     )
     with pytest.raises(UnexpectedStatusCode):
         scim_client.query(User, "status-201")
-    scim_client.query(User, "status-201", check_status_code=False)
+    scim_client.query(User, "status-201", expected_status_codes=None)
 
 
 def test_response_content_type_with_charset(client):