feat: discover has parameters to select which objects to discover

Author: azmeuk

doc/changelog.rst

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+[0.4.2] - Unreleased
+--------------------
+
+Added
+^^^^^
+- :class:`~scim2_client.client.BaseSyncSCIMClient.discover` has parameters to select which objects to discover.
+
+
 [0.4.1] - 2024-12-02
 --------------------
 

scim2_client/client.py

@@ -798,14 +798,25 @@ def replace(
         """
         raise NotImplementedError()
 
-    def discover(self):
-        """Dynamically discover the server models :class:`~scim2_models.Schema` and :class:`~scim2_models.ResourceType`."""
-        resource_types_response = self.query(ResourceType)
-        schemas_response = self.query(Schema)
-        self.service_provider_config = self.query(ServiceProviderConfig)
-        self.resource_types = resource_types_response.resources
-        schemas = schemas_response.resources
-        self.resource_models = self.build_resource_models(self.resource_types, schemas)
+    def discover(self, schemas=True, resource_types=True, service_provider_config=True):
+        """Dynamically discover the server configuration objects.
+
+        :param schemas: Whether to discover the :class:`~scim2_models.Schema` endpoint.
+        :param resource_types: Whether to discover the :class:`~scim2_models.ResourceType` endpoint.
+        :param service_provider_config: Whether to discover the :class:`~scim2_models.ServiceProviderConfig` endpoint.
+        """
+        if resource_types:
+            resource_types_response = self.query(ResourceType)
+            self.resource_types = resource_types_response.resources
+
+        if schemas:
+            schemas_response = self.query(Schema)
+            self.resource_models = self.build_resource_models(
+                self.resource_types, schemas_response.resources
+            )
+
+        if service_provider_config:
+            self.service_provider_config = self.query(ServiceProviderConfig)
 
 
 class BaseAsyncSCIMClient(SCIMClient):
@@ -1064,14 +1075,33 @@ async def replace(
         """
         raise NotImplementedError()
 
-    async def discover(self):
-        """Dynamically discover the server models :class:`~scim2_models.Schema` and :class:`~scim2_models.ResourceType`."""
-        resources_task = asyncio.create_task(self.query(ResourceType))
-        schemas_task = asyncio.create_task(self.query(Schema))
-        spc_task = asyncio.create_task(self.query(ServiceProviderConfig))
-        resource_types_response = await resources_task
-        schemas_response = await schemas_task
-        self.service_provider_config = await spc_task
-        self.resource_types = resource_types_response.resources
-        schemas = schemas_response.resources
-        self.resource_models = self.build_resource_models(self.resource_types, schemas)
+    async def discover(
+        self, schemas=True, resource_types=True, service_provider_config=True
+    ):
+        """Dynamically discover the server configuration objects.
+
+        :param schemas: Whether to discover the :class:`~scim2_models.Schema` endpoint.
+        :param resource_types: Whether to discover the :class:`~scim2_models.ResourceType` endpoint.
+        :param service_provider_config: Whether to discover the :class:`~scim2_models.ServiceProviderConfig` endpoint.
+        """
+        if schemas:
+            schemas_task = asyncio.create_task(self.query(Schema))
+
+        if resource_types:
+            resources_types_task = asyncio.create_task(self.query(ResourceType))
+
+        if service_provider_config:
+            spc_task = asyncio.create_task(self.query(ServiceProviderConfig))
+
+        if resource_types:
+            resource_types_response = await resources_types_task
+            self.resource_types = resource_types_response.resources
+
+        if schemas:
+            schemas_response = await schemas_task
+            self.resource_models = self.build_resource_models(
+                self.resource_types, schemas_response.resources
+            )
+
+        if service_provider_config:
+            self.service_provider_config = await spc_task

tests/engines/test_httpx.py

@@ -45,6 +45,13 @@ def test_sync_engine(server):
     client = Client(base_url=f"http://{host}:{port}")
     scim_client = SyncSCIMClient(client)
 
+    scim_client.discover(
+        schemas=False, resource_types=False, service_provider_config=False
+    )
+    assert not scim_client.resource_models
+    assert not scim_client.resource_types
+    assert not scim_client.service_provider_config
+
     scim_client.discover()
     assert isinstance(scim_client.service_provider_config, ServiceProviderConfig)
     User = scim_client.get_resource_model("User")
@@ -82,6 +89,13 @@ async def test_async_engine(server):
     client = AsyncClient(base_url=f"http://{host}:{port}")
     scim_client = AsyncSCIMClient(client)
 
+    await scim_client.discover(
+        schemas=False, resource_types=False, service_provider_config=False
+    )
+    assert not scim_client.resource_models
+    assert not scim_client.resource_types
+    assert not scim_client.service_provider_config
+
     await scim_client.discover()
     assert isinstance(scim_client.service_provider_config, ServiceProviderConfig)
     User = scim_client.get_resource_model("User")