scim2-cli 0.3.0__tar.gz → 0.4.1__tar.gz

{scim2_cli-0.3.0 → scim2_cli-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: scim2-cli
-Version: 0.3.0
+Version: 0.4.1
 Summary: SCIM application development CLI
 Keywords: scim,scim2,provisioning,rfc7643,rfc7644
 Author: Yaal Coop
@@ -208,7 +208,6 @@ License:                                  Apache License
             limitations under the License.
 Classifier: Intended Audience :: Developers
 Classifier: Development Status :: 3 - Alpha
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -219,12 +218,12 @@ Classifier: Environment :: Web Environment
 Classifier: Programming Language :: Python
 Classifier: Operating System :: OS Independent
 Requires-Dist: click>=8.1.7
-Requires-Dist: scim2-client[httpx2]>=0.8.0
-Requires-Dist: scim2-tester>=0.3.0
-Requires-Dist: sphinx-click-rst-to-ansi-formatter>=0.1.0
+Requires-Dist: scim2-client[httpx2]>=0.11.2
+Requires-Dist: scim2-tester>=0.4.0
+Requires-Dist: sphinx-click-rst-to-ansi-formatter>=0.2.0
 Requires-Dist: pydanclick>=0.5.0
 Requires-Dist: pygments>=2.18.0
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Project-URL: documentation, https://scim2-cli.readthedocs.io
 Project-URL: repository, https://github.com/python-scim/scim2-cli
 Project-URL: changelog, https://scim2-cli.readthedocs.io/en/latest/changelog.html

{scim2_cli-0.3.0 → scim2_cli-0.4.1}/pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["uv_build>=0.12.16,<0.13.0"]
+requires = ["uv_build>=0.12.13,<0.13.0"]
 build-backend = "uv_build"
 
 [project]
 name = "scim2-cli"
-version = "0.3.0"
+version = "0.4.1"
 description = "SCIM application development CLI"
 readme = "README.md"
 keywords = [
@@ -17,7 +17,6 @@ keywords = [
 classifiers = [
     "Intended Audience :: Developers",
     "Development Status :: 3 - Alpha",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
@@ -28,12 +27,12 @@ classifiers = [
     "Programming Language :: Python",
     "Operating System :: OS Independent",
 ]
-requires-python = ">= 3.10"
+requires-python = ">= 3.11"
 dependencies = [
     "click>=8.1.7",
-    "scim2-client[httpx2]>=0.8.0",
-    "scim2-tester>=0.3.0",
-    "sphinx-click-rst-to-ansi-formatter>=0.1.0",
+    "scim2-client[httpx2]>=0.11.2",
+    "scim2-tester>=0.4.0",
+    "sphinx-click-rst-to-ansi-formatter>=0.2.0",
     "pydanclick>=0.5.0",
     "pygments>=2.18.0",
 ]
@@ -57,10 +56,10 @@ scim2 = "scim2_cli:cli"
 
 [dependency-groups]
 dev = [
-    "mypy>=1.13.0",
+    "mypy>=2.3.1",
     "prek>=0.1.0",
     "pytest>=8.2.1",
-    "pytest-coverage>=0.0",
+    "pytest-cov>=6.0.0",
     "pytest-httpserver>=1.0.10",
     "tox-uv>=1.16.0",
 ]
@@ -76,6 +75,18 @@ doc = [
 ]
 bundle = ["pyinstaller>=6.10.0"]
 
+[tool.uv]
+exclude-newer = "14 days"
+
+[tool.uv.exclude-newer-package]
+scim2-models = false
+scim2-client = false
+scim2-server = false
+scim2-cli = false
+scim2-tester = false
+pytest-scim2-server = false
+sphinx-click-rst-to-ansi-formatter = false
+
 [tool.uv.build-backend]
 module-root = ""
 
@@ -94,6 +105,7 @@ exclude_lines = [
     "raise NotImplementedError",
     "except ImportError",
     "if app.debug",
+    "if TYPE_CHECKING:",
 ]
 
 [tool.ruff.lint]
@@ -131,6 +143,12 @@ ignore-words-list = "datas"
 
 [tool.mypy]
 plugins = ["pydantic.mypy"]
+files = ["scim2_cli"]
+strict = true
+
+[tool.pydantic-mypy]
+init_forbid_extra = true
+init_typed = true
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
@@ -139,7 +157,6 @@ testpaths = ["tests"]
 requires = ["tox>=4.19"]
 env_list = [
     "style",
-    "py310",
     "py311",
     "py312",
     "py313",

{scim2_cli-0.3.0 → scim2_cli-0.4.1}/pyproject.toml.orig

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["uv_build>=0.12.16,<0.13.0"]
+requires = ["uv_build>=0.12.13,<0.13.0"]
 build-backend = "uv_build"
 
 [project]
 name = "scim2-cli"
-version = "0.3.0"
+version = "0.4.1"
 description = "SCIM application development CLI"
 authors = [{name="Yaal Coop", email="contact@yaal.coop"}]
 license = {file = "LICENSE.md"}
@@ -13,7 +13,6 @@ keywords = ["scim", "scim2", "provisioning", "rfc7643", "rfc7644"]
 classifiers = [
     "Intended Audience :: Developers",
     "Development Status :: 3 - Alpha",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
@@ -25,12 +24,12 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 
-requires-python = ">= 3.10"
+requires-python = ">= 3.11"
 dependencies = [
     "click>=8.1.7",
-    "scim2-client[httpx2]>=0.8.0",
-    "scim2-tester>=0.3.0",
-    "sphinx-click-rst-to-ansi-formatter>=0.1.0",
+    "scim2-client[httpx2]>=0.11.2",
+    "scim2-tester>=0.4.0",
+    "sphinx-click-rst-to-ansi-formatter>=0.2.0",
     "pydanclick>=0.5.0",
     "pygments>=2.18.0",
 ]
@@ -43,10 +42,10 @@ funding = "https://github.com/sponsors/python-scim"
 
 [dependency-groups]
 dev = [
-    "mypy>=1.13.0",
+    "mypy>=2.3.1",
     "prek>=0.1.0",
     "pytest>=8.2.1",
-    "pytest-coverage>=0.0",
+    "pytest-cov>=6.0.0",
     "pytest-httpserver>=1.0.10",
     "tox-uv>=1.16.0",
 ]
@@ -68,6 +67,11 @@ bundle = [
 scim = "scim2_cli:cli"
 scim2 = "scim2_cli:cli"
 
+[tool.uv]
+exclude-newer = "14 days"
+# TODO: remove sphinx-click-rst-to-ansi-formatter after 2026-10-20, when 0.2.0 is older than 14 days.
+exclude-newer-package = { scim2-models = false, scim2-client = false, scim2-server = false, scim2-cli = false, scim2-tester = false, pytest-scim2-server = false, sphinx-click-rst-to-ansi-formatter = false }
+
 [tool.uv.build-backend]
 module-root = ""
 
@@ -86,6 +90,7 @@ exclude_lines = [
     "raise NotImplementedError",
     "except ImportError",
     "if app.debug",
+    "if TYPE_CHECKING:",
 ]
 
 [tool.ruff.lint]
@@ -125,6 +130,12 @@ ignore-words-list = "datas"
 plugins = [
   "pydantic.mypy"
 ]
+files = ["scim2_cli"]
+strict = true
+
+[tool.pydantic-mypy]
+init_forbid_extra = true
+init_typed = true
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
@@ -133,7 +144,6 @@ testpaths = ["tests"]
 requires = ["tox>=4.19"]
 env_list = [
     "style",
-    "py310",
     "py311",
     "py312",
     "py313",

{scim2_cli-0.3.0 → scim2_cli-0.4.1}/scim2_cli/__init__.py

@@ -1,16 +1,21 @@
 import json
 import re
+import sys
+from typing import IO
+from typing import Any
+from typing import TypeVar
+from typing import cast
 
 import click
 from httpx2 import Client
 from scim2_client.engines.httpx2 import SyncSCIMClient
-from scim2_models import Group
 from scim2_models import ListResponse
 from scim2_models import Resource
 from scim2_models import ResourceType
 from scim2_models import Schema
+from scim2_models import ScimProvider
+from scim2_models import ScimProviderError
 from scim2_models import ServiceProviderConfig
-from scim2_models import User
 from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
 from scim2_cli.create import create_cli
@@ -22,48 +27,50 @@ from scim2_cli.test import test_cli
 from scim2_cli.utils import DOC_URL
 from scim2_cli.utils import SCIM_EXCEPTIONS
 from scim2_cli.utils import HeaderType
+from scim2_cli.utils import escape_control_characters
 from scim2_cli.utils import exception_to_click_error
 from scim2_cli.utils import split_headers
 
-
-def load_config_files(
-    schemas_fd, resource_types_fd, service_provider_config_fd
-) -> tuple[
-    list[type[Resource]], list[ResourceType] | None, ServiceProviderConfig | None
-]:
-    if schemas_fd:
-        schemas_payload = json.load(schemas_fd)
-        if isinstance(schemas_payload, dict):
-            schemas_obj = ListResponse[Schema].model_validate(schemas_payload).resources
-        else:
-            schemas_obj = [Schema.model_validate(schema) for schema in schemas_payload]
-        resource_models = [Resource.from_schema(schema) for schema in schemas_obj]
-
-    else:
-        resource_models = [User, Group]
-
-    if resource_types_fd:
-        resource_types_payload = json.load(resource_types_fd)
-        if isinstance(schemas_payload, dict):
-            resource_types = (
-                ListResponse[ResourceType]
-                .model_validate(resource_types_payload)
-                .resources
-            )
-        else:
-            resource_types = [
-                ResourceType.model_validate(item) for item in resource_types_payload
-            ]
-    else:
-        resource_types = None
-
-    if service_provider_config_fd:
-        spc_payload = json.load(service_provider_config_fd)
-        service_provider_config = ServiceProviderConfig.model_validate(spc_payload)
-    else:
-        service_provider_config = None
-
-    return resource_models, resource_types, service_provider_config
+ResourceT = TypeVar("ResourceT", bound=Resource[Any])
+
+
+def load_objects(fd: IO[str], model: type[ResourceT]) -> list[ResourceT]:
+    """Read a list of objects, bare or wrapped in a ListResponse, from a JSON file."""
+    payload = json.load(fd)
+    if isinstance(payload, dict):
+        list_response: ListResponse[ResourceT] = cast(Any, ListResponse)[
+            model
+        ].model_validate(payload)
+        return list_response.resources or []
+    return [model.model_validate(item) for item in payload]
+
+
+def describe_server(
+    scim_client: SyncSCIMClient,
+    schemas_fd: IO[str] | None,
+    resource_types_fd: IO[str] | None,
+    service_provider_config_fd: IO[str] | None,
+) -> ScimProvider:
+    """Describe the server with the configuration files, and query it for the others."""
+    resource_types = (
+        load_objects(resource_types_fd, ResourceType)
+        if resource_types_fd
+        else cast(
+            "ListResponse[ResourceType]", scim_client.query(ResourceType)
+        ).resources
+        or []
+    )
+    schemas = (
+        load_objects(schemas_fd, Schema)
+        if schemas_fd
+        else cast("ListResponse[Schema]", scim_client.query(Schema)).resources or []
+    )
+    config = (
+        ServiceProviderConfig.model_validate(json.load(service_provider_config_fd))
+        if service_provider_config_fd
+        else cast(ServiceProviderConfig, scim_client.query(ServiceProviderConfig))
+    )
+    return ScimProvider.from_discovery(schemas, resource_types, config)
 
 
 @click.group(cls=make_rst_to_ansi_formatter(DOC_URL, group=True))
@@ -73,7 +80,7 @@ def load_config_files(
     "--header",
     multiple=True,
     type=HeaderType(),
-    help="Headers to pass in the HTTP requests. Can be passed multiple times.",
+    help="Headers to pass in the HTTP requests. Can be passed multiple times. Other users of the machine can see the command line arguments, so pass the secrets with the SCIM_CLI_HEADERS environment variable.",
     envvar="SCIM_CLI_HEADERS",
 )
 @click.option(
@@ -105,14 +112,14 @@ def load_config_files(
 )
 @click.pass_context
 def cli(
-    ctx,
-    url: str,
+    ctx: click.Context,
+    url: str | None,
     header: list[str],
-    no_verify,
-    schemas,
-    resource_types,
-    service_provider_config,
-):
+    no_verify: bool,
+    schemas: IO[str] | None,
+    resource_types: IO[str] | None,
+    service_provider_config: IO[str] | None,
+) -> None:
     """SCIM application development CLI."""
     ctx.ensure_object(dict)
 
@@ -122,33 +129,25 @@ def cli(
     headers_dict = split_headers(header)
     client = Client(base_url=url, headers=headers_dict, verify=not no_verify)
 
-    resource_models, resource_types_obj, spc_obj = load_config_files(
-        schemas, resource_types, service_provider_config
-    )
-
-    scim_client = SyncSCIMClient(
-        client,
-        resource_models=resource_models,
-        resource_types=resource_types_obj,
-        service_provider_config=spc_obj,
-    )
+    scim_client = SyncSCIMClient(client)
     try:
-        scim_client.discover(
-            schemas=not bool(schemas),
-            resource_types=not bool(resource_types),
-            service_provider_config=not bool(service_provider_config),
+        scim_client.provider = describe_server(
+            scim_client, schemas, resource_types, service_provider_config
         )
-    except SCIM_EXCEPTIONS as exc:
+    except (*SCIM_EXCEPTIONS, ScimProviderError) as exc:
         raise exception_to_click_error(exc) from exc
 
+    provider = scim_client.provider
     ctx.obj["client"] = scim_client
-    ctx.obj["resource_models"] = {
-        re.sub(r"\[.*\]", "", resource_model.__name__.lower()): resource_model
-        for resource_model in ctx.obj["client"].resource_models
-    }
-
-    if not click.get_text_stream("stdin").isatty():  # pragma: no cover
-        if stdin := click.get_text_stream("stdin").read().strip():
+    ctx.obj["resource_models"] = {}
+    for resource_type in provider.resource_types:
+        resource_model = provider.model_for(resource_type)
+        assert resource_model is not None
+        name = re.sub(r"\[.*\]", "", resource_model.__name__.lower())
+        ctx.obj["resource_models"][escape_control_characters(name)] = resource_model
+
+    if not sys.stdin.isatty():  # pragma: no cover
+        if stdin := sys.stdin.read().strip():
             try:
                 ctx.obj["stdin"] = json.loads(stdin)
             except json.JSONDecodeError as exc:

{scim2_cli-0.3.0 → scim2_cli-0.4.1}/scim2_cli/create.py

@@ -1,29 +1,40 @@
+from typing import Any
+from typing import cast
+
 import click
 from click import ClickException
 from pydanclick import from_pydantic
+from scim2_client.engines.httpx2 import SyncSCIMClient
 from scim2_models import Context
+from scim2_models import Error
+from scim2_models import Resource
 from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
 from scim2_cli.utils import DOC_URL
 from scim2_cli.utils import SCIM_EXCEPTIONS
 from scim2_cli.utils import ModelCommand
+from scim2_cli.utils import escape_options_help
 from scim2_cli.utils import exception_to_click_error
 from scim2_cli.utils import formatted_payload
 from scim2_cli.utils import unacceptable_fields
 
 
-def create_payload(client, payload, indent):
+def create_payload(
+    client: SyncSCIMClient, payload: Resource[Any] | dict[str, Any], indent: bool
+) -> None:
     try:
-        response = client.create(payload, raise_scim_errors=False)
+        # Response payloads are always checked, so the client never returns a dict.
+        response = cast(
+            "Resource[Any] | Error", client.create(payload, raise_scim_errors=False)
+        )
 
     except SCIM_EXCEPTIONS as scim_exc:
         raise exception_to_click_error(scim_exc) from scim_exc
 
-    payload = formatted_payload(response.model_dump(), indent)
-    click.echo(payload)
+    click.echo(formatted_payload(response.model_dump(), indent))
 
 
-def create_factory(model):
+def create_factory(model: type[Resource[Any]] | None) -> click.Command:
     if not model:
         raise ClickException("Invalid model")
 
@@ -41,7 +52,13 @@ def create_factory(model):
     )
     @from_pydantic("obj", model, exclude=exclude)
     @click.pass_context
-    def create_command(ctx, indent, obj: model, *args, **kwargs):
+    def create_command(
+        ctx: click.Context,
+        indent: bool,
+        obj: Resource[Any] | None,
+        *args: Any,
+        **kwargs: Any,
+    ) -> None:
         r"""Perform a `SCIM POST <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request on resources endpoint.
 
         Input data can be passed through parameters like :code:`--external-id`.
@@ -75,7 +92,7 @@ def create_factory(model):
 
         create_payload(ctx.obj["client"], payload, indent)
 
-    return create_command
+    return escape_options_help(create_command)
 
 
 @click.command(
@@ -91,7 +108,7 @@ def create_factory(model):
     default=True,
     help="Indent JSON response payloads.",
 )
-def create_cli(ctx, indent):
+def create_cli(ctx: click.Context, indent: bool) -> None:
     """Perform a `SCIM POST <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request on resources endpoint.
 
     There are subcommands for all the available models, with dynamic attributes.

{scim2_cli-0.3.0 → scim2_cli-0.4.1}/scim2_cli/delete.py

@@ -21,7 +21,7 @@ from .utils import formatted_payload
     help="Indent JSON response payloads.",
 )
 @click.pass_context
-def delete_cli(ctx, resource_type, id, indent):
+def delete_cli(ctx: click.Context, resource_type: str, id: str, indent: bool) -> None:
     """Perform a `SCIM DELETE query <https://www.rfc-editor.org/rfc/rfc7644#section-3.6>`_ request.
 
     .. code-block:: bash

{scim2_cli-0.3.0 → scim2_cli-0.4.1}/scim2_cli/query.py

@@ -56,18 +56,18 @@ from .utils import formatted_payload
     help="Indent JSON response payloads.",
 )
 def query_cli(
-    ctx,
+    ctx: click.Context,
     resource_type: str | None,
     id: str | None,
     attribute: list[str],
     excluded_attribute: list[str],
-    start_index: int,
-    count: int,
-    filter: str,
-    sort_by: str,
-    sort_order: str,
+    start_index: int | None,
+    count: int | None,
+    filter: str | None,
+    sort_by: str | None,
+    sort_order: str | None,
     indent: bool,
-):
+) -> None:
     """Perform a `SCIM GET <https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1>`_ request on the :code:`RESOURCE_TYPE` endpoint.
 
     - If :code:`RESOURCE_TYPE` is :code:`user` and :code:`id` is `1234`, then the request will made on the :code:`/Users/1234` endpoint.
@@ -84,19 +84,20 @@ def query_cli(
         echo '{"startIndex": 50, "count": 10}' |  query user
 
     """
-    for model in (Schema, ResourceType, ServiceProviderConfig):
-        ctx.obj["resource_models"][model.__name__.lower()] = model
+    for discovery_model in (Schema, ResourceType, ServiceProviderConfig):
+        ctx.obj["resource_models"][discovery_model.__name__.lower()] = discovery_model
 
+    model = None
     if resource_type:
         try:
-            resource_type = ctx.obj["resource_models"][resource_type]
+            model = ctx.obj["resource_models"][resource_type]
         except KeyError as exc:
             ok_values = ", ".join(ctx.obj["resource_models"])
             raise ClickException(
                 f"Unknown resource type '{resource_type}. Available values are: {ok_values}'"
             ) from exc
 
-    single_resource = bool(id) or resource_type is ServiceProviderConfig
+    single_resource = bool(id) or model is ServiceProviderConfig
     listing_options = [
         name
         for name, value in (
@@ -119,26 +120,30 @@ def query_cli(
 
     elif single_resource:
         check_request_payload = True
-        payload = ResponseParameters(
-            attributes=attribute,
-            excluded_attributes=excluded_attribute,
+        payload = ResponseParameters.model_validate(
+            {
+                "attributes": attribute,
+                "excluded_attributes": excluded_attribute,
+            }
         )
 
     else:
         check_request_payload = True
-        payload = SearchRequest(
-            attributes=attribute,
-            excluded_attributes=excluded_attribute,
-            start_index=start_index,
-            count=count,
-            filter=filter,
-            sort_by=sort_by,
-            sort_order=sort_order,
+        payload = SearchRequest.model_validate(
+            {
+                "attributes": attribute,
+                "excluded_attributes": excluded_attribute,
+                "start_index": start_index,
+                "count": count,
+                "filter": filter,
+                "sort_by": sort_by,
+                "sort_order": sort_order,
+            }
         )
 
     try:
         response = ctx.obj["client"].query(
-            resource_type,
+            model,
             id,
             query_parameters=payload,
             check_request_payload=check_request_payload,

{scim2_cli-0.3.0 → scim2_cli-0.4.1}/scim2_cli/replace.py

@@ -1,9 +1,16 @@
+from typing import Any
+from typing import cast
+
 import click
 from click import ClickException
 from pydanclick import from_pydantic
+from scim2_client.engines.httpx2 import SyncSCIMClient
 from scim2_models import Context
+from scim2_models import Error
+from scim2_models import Resource
 from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
+from scim2_cli.utils import escape_options_help
 from scim2_cli.utils import exception_to_click_error
 
 from .utils import DOC_URL
@@ -13,18 +20,22 @@ from .utils import formatted_payload
 from .utils import unacceptable_fields
 
 
-def replace_payload(client, payload, indent):
+def replace_payload(
+    client: SyncSCIMClient, payload: Resource[Any] | dict[str, Any], indent: bool
+) -> None:
     try:
-        response = client.replace(payload, raise_scim_errors=False)
+        # Response payloads are always checked, so the client never returns a dict.
+        response = cast(
+            "Resource[Any] | Error", client.replace(payload, raise_scim_errors=False)
+        )
 
     except SCIM_EXCEPTIONS as scim_exc:
         raise exception_to_click_error(scim_exc) from scim_exc
 
-    payload = formatted_payload(response.model_dump(), indent)
-    click.echo(payload)
+    click.echo(formatted_payload(response.model_dump(), indent))
 
 
-def replace_factory(model):
+def replace_factory(model: type[Resource[Any]] | None) -> click.Command:
     if not model:
         raise ClickException("Invalid model")
 
@@ -43,7 +54,13 @@ def replace_factory(model):
     )
     @from_pydantic("obj", model, exclude=exclude)
     @click.pass_context
-    def replace_command(ctx, indent, obj: model, *args, **kwargs):
+    def replace_command(
+        ctx: click.Context,
+        indent: bool,
+        obj: Resource[Any] | None,
+        *args: Any,
+        **kwargs: Any,
+    ) -> None:
         r"""Perform a `SCIM PUT <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request on resources endpoint.
 
         Input data can be passed through parameters like :code:`--external-id`.
@@ -82,7 +99,7 @@ def replace_factory(model):
             indent,
         )
 
-    return replace_command
+    return escape_options_help(replace_command)
 
 
 @click.command(
@@ -98,7 +115,7 @@ def replace_factory(model):
     default=True,
     help="Indent JSON response payloads.",
 )
-def replace_cli(ctx, indent):
+def replace_cli(ctx: click.Context, indent: bool) -> None:
     """Perform a `SCIM PUT <https://www.rfc-editor.org/rfc/rfc7644#section-3.5.1>`_ request on the resources endpoint.
 
     There are subcommands for all the available models, with dynamic attributes.

{scim2_cli-0.3.0 → scim2_cli-0.4.1}/scim2_cli/search.py

@@ -49,16 +49,16 @@ from .utils import formatted_payload
     help="Indent JSON response payloads.",
 )
 def search_cli(
-    ctx,
+    ctx: click.Context,
     attribute: list[str],
     excluded_attribute: list[str],
-    start_index: int,
-    count: int,
-    filter: str,
-    sort_by: str,
-    sort_order: str,
+    start_index: int | None,
+    count: int | None,
+    filter: str | None,
+    sort_by: str | None,
+    sort_order: str | None,
     indent: bool,
-):
+) -> None:
     """Perform a `SCIM GET <https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1>`_ request on the :code:`/.search` endpoint.
 
     Data passed in JSON format to stdin is sent as request arguments and all the other query arguments are ignored:
@@ -74,14 +74,16 @@ def search_cli(
 
     else:
         check_request_payload = True
-        payload = SearchRequest(
-            attributes=attribute,
-            excluded_attributes=excluded_attribute,
-            start_index=start_index,
-            count=count,
-            filter=filter,
-            sort_by=sort_by,
-            sort_order=sort_order,
+        payload = SearchRequest.model_validate(
+            {
+                "attributes": attribute,
+                "excluded_attributes": excluded_attribute,
+                "start_index": start_index,
+                "count": count,
+                "filter": filter,
+                "sort_by": sort_by,
+                "sort_order": sort_order,
+            }
         )
 
     try:

{scim2_cli-0.3.0 → scim2_cli-0.4.1}/scim2_cli/test.py

@@ -7,6 +7,7 @@ from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
 from .utils import DOC_URL
 from .utils import Color
+from .utils import escape_control_characters
 
 
 @click.command(cls=make_rst_to_ansi_formatter(DOC_URL), name="test")
@@ -24,7 +25,9 @@ from .utils import Color
     default=True,
     help="Fail on unexpected content types.",
 )
-def test_cli(ctx, verbose, check_status_code, check_content_type):
+def test_cli(
+    ctx: click.Context, verbose: bool, check_status_code: bool, check_content_type: bool
+) -> None:
     """Perform a server SCIM compliance check using :doc:`scim2-tester <scim2_tester:index>`.
 
     .. code-block:: bash
@@ -43,11 +46,11 @@ def test_cli(ctx, verbose, check_status_code, check_content_type):
         else:
             status = click.style(result.status.name, fg=Color.red)
             success = False
-        click.echo(f"{status} {result.title}")
+        click.echo(f"{status} {escape_control_characters(result.title)}")
 
         if result.reason:
-            click.echo(f"  {result.reason}")
+            click.echo(f"  {escape_control_characters(result.reason)}")
             if verbose and result.data:
-                click.echo(f"  {result.data}")
+                click.echo(f"  {escape_control_characters(result.data)}")
 
     sys.exit(0 if success else 1)

{scim2_cli-0.3.0 → scim2_cli-0.4.1}/scim2_cli/utils.py

@@ -1,24 +1,34 @@
 import json
-import sys
-from enum import Enum
+import re
+from collections.abc import Callable
+from enum import StrEnum
+from typing import Any
 
 import click
 from scim2_client import SCIMClientException
+from scim2_models import BaseModel
+from scim2_models import Context
+from scim2_models import Mutability
+from scim2_models import Resource
 from scim2_models import SCIMException
-from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
+from sphinx_click.rst_to_ansi_formatter import RstToAnsiGroup
 
 DOC_URL = "https://scim2-cli.readthedocs.io/"
 INDENTATION_SIZE = 4
 
 SCIM_EXCEPTIONS = (SCIMClientException, SCIMException)
 
+CONTROL_CHARACTERS = re.compile(
+    "[\x00-\x08\x0b-\x1f\x7f-\x9f\u061c\u200e\u200f\u202a-\u202e\u2066-\u2069]"
+)
 
-class HeaderType(click.ParamType):
+
+class HeaderType(click.types.StringParamType):
     envvar_list_splitter = ";"
     name = "HEADER"
 
 
-class Color(str, Enum):
+class Color(StrEnum):
     black = "black"
     red = "red"
     green = "green"
@@ -37,9 +47,27 @@ class Color(str, Enum):
     bright_white = "bright_white"
 
 
-def formatted_payload(obj, indent):
-    indent = INDENTATION_SIZE if indent else False
-    return json.dumps(obj, indent=indent)
+def escape_control_characters(text: object) -> str:
+    """Replace the control characters of a text by their escaped form.
+
+    The texts coming from the server would otherwise be interpreted by the
+    terminal as escape sequences.
+    """
+    return CONTROL_CHARACTERS.sub(
+        lambda match: match.group().encode("unicode_escape").decode(), str(text)
+    )
+
+
+def escape_options_help(command: click.Command) -> click.Command:
+    """Escape the option help texts pydanclick takes from the schema descriptions."""
+    for param in command.params:
+        if isinstance(param, click.Option) and param.help:
+            param.help = escape_control_characters(param.help)
+    return command
+
+
+def formatted_payload(obj: Any, indent: bool) -> str:
+    return json.dumps(obj, indent=INDENTATION_SIZE if indent else None)
 
 
 def split_headers(headers: list[str]) -> dict[str, str]:
@@ -53,32 +81,35 @@ def split_headers(headers: list[str]) -> dict[str, str]:
     }
 
 
-RSTCommand: click.Group = make_rst_to_ansi_formatter(DOC_URL, group=True)
-
-
-class ModelCommand(RSTCommand):
+class ModelCommand(RstToAnsiGroup):
     """CLI commands that takes a model subcommand."""
 
-    def __init__(self, *args, factory, **kwargs):
+    base_url = DOC_URL
+
+    def __init__(
+        self,
+        *args: Any,
+        factory: Callable[[type[Resource[Any]] | None], click.Command],
+        **kwargs: Any,
+    ) -> None:
         super().__init__(*args, **kwargs)
         self.factory = factory
 
-    def list_commands(self, ctx):
+    def list_commands(self, ctx: click.Context) -> list[str]:
         ctx.ensure_object(dict)
         base = super().list_commands(ctx)
         lazy = sorted(ctx.obj.get("resource_models", {}).keys())
         return base + lazy
 
-    def get_command(self, ctx, cmd_name):
+    def get_command(self, ctx: click.Context, cmd_name: str) -> click.Command:
         model = ctx.obj["resource_models"].get(cmd_name)
         return self.factory(model)
 
 
-def is_field_acceptable(context, model, field_name) -> bool:
+def is_field_acceptable(
+    context: Context, model: type[BaseModel], field_name: str
+) -> bool:
     """Indicate whether a field is acceptable as part of a SCIM payload for a given context."""
-    from scim2_models import Context
-    from scim2_models import Mutability
-
     mutability = model.get_field_annotation(field_name, Mutability)
 
     if (
@@ -103,7 +134,7 @@ def is_field_acceptable(context, model, field_name) -> bool:
     return True
 
 
-def unacceptable_fields(context, model):
+def unacceptable_fields(context: Context, model: type[BaseModel]) -> list[str]:
     excluded = [
         field_name
         for field_name in model.model_fields
@@ -113,10 +144,8 @@ def unacceptable_fields(context, model):
     return excluded
 
 
-def exception_to_click_error(exception):
+def exception_to_click_error(exception: Exception) -> click.ClickException:
     message = str(exception)
-    if sys.version_info >= (3, 11) and hasattr(
-        exception, "__notes__"
-    ):  # pragma: no cover
+    if hasattr(exception, "__notes__"):
         message += "\n" + "\n".join(exception.__notes__)
-    return click.ClickException(message)
+    return click.ClickException(escape_control_characters(message))