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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: scim2-cli
-Version: 0.3.0
+Version: 0.4.0
 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: scim2-client[httpx2]>=0.9.0
+Requires-Dist: scim2-tester>=0.4.0
 Requires-Dist: sphinx-click-rst-to-ansi-formatter>=0.1.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.0}/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.0"
 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,11 +27,11 @@ 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",
+    "scim2-client[httpx2]>=0.9.0",
+    "scim2-tester>=0.4.0",
     "sphinx-click-rst-to-ansi-formatter>=0.1.0",
     "pydanclick>=0.5.0",
     "pygments>=2.18.0",
@@ -60,7 +59,7 @@ dev = [
     "mypy>=1.13.0",
     "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,17 @@ 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
+
 [tool.uv.build-backend]
 module-root = ""
 
@@ -139,7 +149,6 @@ testpaths = ["tests"]
 requires = ["tox>=4.19"]
 env_list = [
     "style",
-    "py310",
     "py311",
     "py312",
     "py313",

{scim2_cli-0.3.0 → scim2_cli-0.4.0}/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.0"
 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,11 +24,11 @@ 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",
+    "scim2-client[httpx2]>=0.9.0",
+    "scim2-tester>=0.4.0",
     "sphinx-click-rst-to-ansi-formatter>=0.1.0",
     "pydanclick>=0.5.0",
     "pygments>=2.18.0",
@@ -46,7 +45,7 @@ dev = [
     "mypy>=1.13.0",
     "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,10 @@ bundle = [
 scim = "scim2_cli:cli"
 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 }
+
 [tool.uv.build-backend]
 module-root = ""
 
@@ -133,7 +136,6 @@ testpaths = ["tests"]
 requires = ["tox>=4.19"]
 env_list = [
     "style",
-    "py310",
     "py311",
     "py312",
     "py313",

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

@@ -4,13 +4,12 @@ import re
 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 +21,39 @@ 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
+def load_objects(fd, model):
+    """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 []
+    return [model.model_validate(item) for item in payload]
+
+
+def describe_server(
+    scim_client, schemas_fd, resource_types_fd, service_provider_config_fd
+) -> 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 []
+    )
+    schemas = (
+        load_objects(schemas_fd, Schema)
+        if schemas_fd
+        else 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)
+    )
+    return ScimProvider.from_discovery(schemas, resource_types, config)
 
 
 @click.group(cls=make_rst_to_ansi_formatter(DOC_URL, group=True))
@@ -73,7 +63,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(
@@ -122,29 +112,21 @@ 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
+        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

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

@@ -7,6 +7,7 @@ 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
@@ -75,7 +76,7 @@ def create_factory(model):
 
         create_payload(ctx.obj["client"], payload, indent)
 
-    return create_command
+    return escape_options_help(create_command)
 
 
 @click.command(

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

@@ -4,6 +4,7 @@ from pydanclick import from_pydantic
 from scim2_models import Context
 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
@@ -82,7 +83,7 @@ def replace_factory(model):
             indent,
         )
 
-    return replace_command
+    return escape_options_help(replace_command)
 
 
 @click.command(

{scim2_cli-0.3.0 → scim2_cli-0.4.0}/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")
@@ -43,11 +44,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.0}/scim2_cli/utils.py

@@ -1,6 +1,6 @@
 import json
-import sys
-from enum import Enum
+import re
+from enum import StrEnum
 
 import click
 from scim2_client import SCIMClientException
@@ -12,13 +12,17 @@ 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):
     envvar_list_splitter = ";"
     name = "HEADER"
 
 
-class Color(str, Enum):
+class Color(StrEnum):
     black = "black"
     red = "red"
     green = "green"
@@ -37,6 +41,25 @@ class Color(str, Enum):
     bright_white = "bright_white"
 
 
+def escape_control_characters(text) -> 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):
+    """Escape the option help texts pydanclick takes from the schema descriptions."""
+    for param in command.params:
+        if 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)
@@ -115,8 +138,6 @@ def unacceptable_fields(context, model):
 
 def exception_to_click_error(exception):
     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))