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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: scim2-cli
-Version: 0.4.0
+Version: 0.4.1
 Summary: SCIM application development CLI
 Keywords: scim,scim2,provisioning,rfc7643,rfc7644
 Author: Yaal Coop
@@ -218,9 +218,9 @@ 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.9.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.1.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.11

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

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "scim2-cli"
-version = "0.4.0"
+version = "0.4.1"
 description = "SCIM application development CLI"
 readme = "README.md"
 keywords = [
@@ -30,9 +30,9 @@ classifiers = [
 requires-python = ">= 3.11"
 dependencies = [
     "click>=8.1.7",
-    "scim2-client[httpx2]>=0.9.0",
+    "scim2-client[httpx2]>=0.11.2",
     "scim2-tester>=0.4.0",
-    "sphinx-click-rst-to-ansi-formatter>=0.1.0",
+    "sphinx-click-rst-to-ansi-formatter>=0.2.0",
     "pydanclick>=0.5.0",
     "pygments>=2.18.0",
 ]
@@ -56,7 +56,7 @@ scim2 = "scim2_cli:cli"
 
 [dependency-groups]
 dev = [
-    "mypy>=1.13.0",
+    "mypy>=2.3.1",
     "prek>=0.1.0",
     "pytest>=8.2.1",
     "pytest-cov>=6.0.0",
@@ -85,6 +85,7 @@ 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 = ""
@@ -104,6 +105,7 @@ exclude_lines = [
     "raise NotImplementedError",
     "except ImportError",
     "if app.debug",
+    "if TYPE_CHECKING:",
 ]
 
 [tool.ruff.lint]
@@ -141,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"]

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

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "scim2-cli"
-version = "0.4.0"
+version = "0.4.1"
 description = "SCIM application development CLI"
 authors = [{name="Yaal Coop", email="contact@yaal.coop"}]
 license = {file = "LICENSE.md"}
@@ -27,9 +27,9 @@ classifiers = [
 requires-python = ">= 3.11"
 dependencies = [
     "click>=8.1.7",
-    "scim2-client[httpx2]>=0.9.0",
+    "scim2-client[httpx2]>=0.11.2",
     "scim2-tester>=0.4.0",
-    "sphinx-click-rst-to-ansi-formatter>=0.1.0",
+    "sphinx-click-rst-to-ansi-formatter>=0.2.0",
     "pydanclick>=0.5.0",
     "pygments>=2.18.0",
 ]
@@ -42,7 +42,7 @@ 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-cov>=6.0.0",
@@ -69,7 +69,8 @@ scim2 = "scim2_cli:cli"
 
 [tool.uv]
 exclude-newer = "14 days"
-exclude-newer-package = { scim2-models = false, scim2-client = false, scim2-server = false, scim2-cli = false, scim2-tester = false, pytest-scim2-server = false }
+# 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 = ""
@@ -89,6 +90,7 @@ exclude_lines = [
     "raise NotImplementedError",
     "except ImportError",
     "if app.debug",
+    "if TYPE_CHECKING:",
 ]
 
 [tool.ruff.lint]
@@ -128,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"]

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

@@ -1,10 +1,16 @@
 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 ListResponse
+from scim2_models import Resource
 from scim2_models import ResourceType
 from scim2_models import Schema
 from scim2_models import ScimProvider
@@ -25,33 +31,44 @@ from scim2_cli.utils import escape_control_characters
 from scim2_cli.utils import exception_to_click_error
 from scim2_cli.utils import split_headers
 
+ResourceT = TypeVar("ResourceT", bound=Resource[Any])
 
-def load_objects(fd, model):
+
+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):
-        return ListResponse[model].model_validate(payload).resources or []
+        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, schemas_fd, resource_types_fd, service_provider_config_fd
+    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 scim_client.query(ResourceType).resources or []
+        else cast(
+            "ListResponse[ResourceType]", scim_client.query(ResourceType)
+        ).resources
+        or []
     )
     schemas = (
         load_objects(schemas_fd, Schema)
         if schemas_fd
-        else scim_client.query(Schema).resources or []
+        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 scim_client.query(ServiceProviderConfig)
+        else cast(ServiceProviderConfig, scim_client.query(ServiceProviderConfig))
     )
     return ScimProvider.from_discovery(schemas, resource_types, config)
 
@@ -95,14 +112,14 @@ def describe_server(
 )
 @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,15 +139,15 @@ def cli(
 
     provider = scim_client.provider
     ctx.obj["client"] = scim_client
-    ctx.obj["resource_models"] = {
-        escape_control_characters(
-            re.sub(r"\[.*\]", "", resource_model.__name__.lower())
-        ): resource_model
-        for resource_model in map(provider.model_for, provider.resource_types)
-    }
-
-    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.4.0 → scim2_cli-0.4.1}/scim2_cli/create.py

@@ -1,7 +1,13 @@
+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
@@ -13,18 +19,22 @@ 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")
 
@@ -42,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`.
@@ -92,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.4.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.4.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.4.0 → scim2_cli-0.4.1}/scim2_cli/replace.py

@@ -1,7 +1,13 @@
+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
@@ -14,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")
 
@@ -44,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`.
@@ -99,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.4.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.4.0 → scim2_cli-0.4.1}/scim2_cli/test.py

@@ -25,7 +25,9 @@ from .utils import escape_control_characters
     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

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

@@ -1,11 +1,17 @@
 import json
 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
@@ -17,7 +23,7 @@ CONTROL_CHARACTERS = re.compile(
 )
 
 
-class HeaderType(click.ParamType):
+class HeaderType(click.types.StringParamType):
     envvar_list_splitter = ";"
     name = "HEADER"
 
@@ -41,7 +47,7 @@ class Color(StrEnum):
     bright_white = "bright_white"
 
 
-def escape_control_characters(text) -> str:
+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
@@ -52,17 +58,16 @@ def escape_control_characters(text) -> str:
     )
 
 
-def escape_options_help(command):
+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 param.help:
+        if isinstance(param, click.Option) and param.help:
             param.help = escape_control_characters(param.help)
     return command
 
 
-def formatted_payload(obj, indent):
-    indent = INDENTATION_SIZE if indent else False
-    return json.dumps(obj, indent=indent)
+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]:
@@ -76,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 (
@@ -126,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
@@ -136,7 +144,7 @@ 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 hasattr(exception, "__notes__"):
         message += "\n" + "\n".join(exception.__notes__)