lib-shopware6-api-base 6.0.0__tar.gz → 6.0.2__tar.gz

{lib_shopware6_api_base-6.0.0 → lib_shopware6_api_base-6.0.2}/.github/workflows/cicd_docker.yml

@@ -107,7 +107,7 @@ jobs:
           && steps.pytest.outcome == 'success'
           && matrix.os == 'ubuntu-latest'
           && matrix.python == '3.13'
-        uses: codecov/codecov-action@v6
+        uses: codecov/codecov-action@v7
         with:
           files: ${{ env.COV_REPORT_FILE }}
           fail_ci_if_error: false
@@ -366,7 +366,7 @@ jobs:
 
       - name: Upload integration coverage to Codecov
         if: always()
-        uses: codecov/codecov-action@v6
+        uses: codecov/codecov-action@v7
         with:
           files: coverage-integration.xml
           flags: integration

{lib_shopware6_api_base-6.0.0 → lib_shopware6_api_base-6.0.2}/CHANGELOG.md

@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [6.0.2] 2026-06-14
+
+### Changed
+- Added a `typed_click.py` facade wrapping rich-click's `option` / `version_option` / `argument` decorators behind explicit, fully-known signatures, keeping the CLI strict-clean under pyright 1.1.410 (`reportUnknownMemberType`) without disabling the rule (ignore isolated to the facade).
+- Bumped internal dependency floors: `lib_cli_exit_tools>=2.3.2`, `lib_log_rich>=6.3.5`, `lib_layered_config>=5.5.2`.
+
+## [6.0.1] - 2026-06-08
+
+### Fixed
+
+- **CLI no longer swallows error messages.** `run_cli` was given a custom
+  `exception_handler` that returned an exit code but never printed, so every failure
+  (bad config, API error, invalid argument) exited non-zero with no diagnostic. The
+  handler now prints the message (terse, or a full traceback under `--traceback`)
+  for non-signal errors, while signals still exit cleanly and quietly.
+- **`--traceback` no longer leaks across invocations.** `main()` snapshots and restores
+  the process-global `lib_cli_exit_tools.config.traceback`, so running the CLI once with
+  `--traceback` in a long-lived process no longer forces full tracebacks on later commands.
+
 ## [6.0.0] - 2026-06-08
 
 ### Breaking Changes

{lib_shopware6_api_base-6.0.0 → lib_shopware6_api_base-6.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lib_shopware6_api_base
-Version: 6.0.0
+Version: 6.0.2
 Summary: python3 base API client for shopware6
 Project-URL: Homepage, https://github.com/bitranox/lib_shopware6_api_base
 Project-URL: Documentation, https://github.com/bitranox/lib_shopware6_api_base/blob/master/README.md
@@ -23,9 +23,9 @@ Classifier: Programming Language :: Python :: 3.14
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
 Requires-Dist: httpx2>=2.3.0
-Requires-Dist: lib-cli-exit-tools>=2.3.1
-Requires-Dist: lib-layered-config>=5.5.1
-Requires-Dist: lib-log-rich>=6.3.4
+Requires-Dist: lib-cli-exit-tools>=2.3.2
+Requires-Dist: lib-layered-config>=5.5.2
+Requires-Dist: lib-log-rich>=6.3.5
 Requires-Dist: orjson
 Requires-Dist: pydantic>=2.13.4
 Requires-Dist: rich-click

{lib_shopware6_api_base-6.0.0 → lib_shopware6_api_base-6.0.2}/pyproject.toml

@@ -1,14 +1,14 @@
 [project]
 name = "lib_shopware6_api_base"
-version = "6.0.0"
+version = "6.0.2"
 description = "python3 base API client for shopware6"
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
     "pydantic>=2.13.4",
-    "lib_layered_config>=5.5.1",
-    "lib_log_rich>=6.3.4",
-    "lib_cli_exit_tools>=2.3.1",
+    "lib_layered_config>=5.5.2",
+    "lib_log_rich>=6.3.5",
+    "lib_cli_exit_tools>=2.3.2",
     "rich-click",
     "orjson",
     "httpx2>=2.3.0",

{lib_shopware6_api_base-6.0.0 → lib_shopware6_api_base-6.0.2}/src/lib_shopware6_api_base/__init__conf__.py

@@ -26,7 +26,7 @@ name = "lib_shopware6_api_base"
 #: Human-readable summary shown in CLI help output.
 title = "python3 base API client for shopware6"
 #: Current release version pulled from ``pyproject.toml`` by automation.
-version = "6.0.0"
+version = "6.0.2"
 #: Repository homepage presented to users.
 homepage = "https://github.com/bitranox/lib_shopware6_api_base"
 #: Author attribution surfaced in CLI output.

{lib_shopware6_api_base-6.0.0 → lib_shopware6_api_base-6.0.2}/src/lib_shopware6_api_base/lib_shopware6_api_base_cli.py

@@ -24,6 +24,7 @@ from .exit_codes import ExitCode
 from .lib_shopware6_admin_client import Shopware6AdminAPIClientBase
 from .lib_shopware6_storefront_client import Shopware6StoreFrontClientBase
 from .logging_setup import init_logging, shutdown_logging
+from .typed_click import argument, option, version_option
 
 # CONSTANTS
 CLICK_CONTEXT_SETTINGS = {"help_option_names": ["-h", "--help"]}
@@ -39,21 +40,25 @@ _EXTRA_SENSITIVE_KEYS = frozenset({"store_api_sw_access_key", "client_id"})
 
 
 def _get_exit_code(exc: BaseException) -> int:
-    """Map exceptions to exit codes.
+    """Map exceptions to exit codes, printing the diagnostic the user needs to see.
 
-    Custom exceptions get specific exit codes.
-    Standard exceptions are delegated to lib_cli_exit_tools.
+    run_cli installs this in place of its default exception handler, so it must also
+    emit the message the default would have printed - otherwise every error exits with
+    a bare code and no output. Signals exit cleanly and quietly (no traceback); all
+    other errors print the message (terse, or a full traceback when --traceback is set)
+    before the mapped exit code is returned.
     """
-    if isinstance(exc, ConfigurationError):
-        return ExitCode.CONFIGURATION_ERROR
-    if isinstance(exc, ShopwareAPIError):
-        return ExitCode.API_ERROR
     if isinstance(exc, lib_cli_exit_tools.SigIntInterrupt):
         return ExitCode.SIGINT
     if isinstance(exc, lib_cli_exit_tools.SigTermInterrupt):
         return ExitCode.SIGTERM
     if isinstance(exc, BrokenPipeError):
         return ExitCode.SIGPIPE
+    lib_cli_exit_tools.print_exception_message()
+    if isinstance(exc, ConfigurationError):
+        return ExitCode.CONFIGURATION_ERROR
+    if isinstance(exc, ShopwareAPIError):
+        return ExitCode.API_ERROR
     if isinstance(exc, ValueError):
         return ExitCode.INVALID_ARGUMENT
     # Delegate to lib_cli_exit_tools for standard exceptions
@@ -107,12 +112,12 @@ def info() -> None:
 
 
 @click.group(help=__init__conf__.title, context_settings=CLICK_CONTEXT_SETTINGS)  # type: ignore
-@click.version_option(
+@version_option(
     version=__init__conf__.version,
     prog_name=__init__conf__.shell_command,
     message=f"{__init__conf__.shell_command} version {__init__conf__.version}",
 )
-@click.option("--traceback/--no-traceback", is_flag=True, type=bool, default=None, help="return traceback information on cli")
+@option("--traceback/--no-traceback", is_flag=True, type=bool, default=None, help="return traceback information on cli")
 def cli_main(traceback: bool | None = None) -> None:
     """Main CLI entry point."""
     if traceback is not None:
@@ -126,7 +131,7 @@ def cli_info() -> None:
 
 
 @cli_main.command("test-connection", context_settings=CLICK_CONTEXT_SETTINGS)  # type: ignore
-@click.option("--storefront/--no-storefront", default=True, help="also verify the Store API access key")
+@option("--storefront/--no-storefront", default=True, help="also verify the Store API access key")
 def cli_test_connection(storefront: bool) -> None:
     """Check that the configured credentials can reach Shopware.
 
@@ -150,7 +155,7 @@ def cli_test_connection(storefront: bool) -> None:
 
 
 @cli_main.command("get", context_settings=CLICK_CONTEXT_SETTINGS)  # type: ignore
-@click.argument("endpoint")
+@argument("endpoint")
 def cli_get(endpoint: str) -> None:
     """Run a read-only Admin API GET and print the JSON response.
 
@@ -169,7 +174,7 @@ def cli_config() -> None:
 
 
 @cli_config.command("show", context_settings=CLICK_CONTEXT_SETTINGS)  # type: ignore
-@click.option(
+@option(
     "--section",
     type=click.Choice(["shopware", "lib_log_rich", "all"]),
     default="all",
@@ -203,6 +208,9 @@ def cli_config_paths() -> None:
 def main() -> int:
     """Entry point with logging setup and proper signal handling."""
     init_logging()
+    # cli_main sets the process-global lib_cli_exit_tools.config.traceback from --traceback;
+    # snapshot and restore it so the flag does not leak into later in-process invocations.
+    traceback_default = lib_cli_exit_tools.config.traceback
     try:
         return lib_cli_exit_tools.run_cli(
             cli_main,
@@ -210,6 +218,7 @@ def main() -> int:
             install_signals=True,
         )
     finally:
+        lib_cli_exit_tools.config.traceback = traceback_default
         shutdown_logging()
 
 

lib_shopware6_api_base-6.0.2/src/lib_shopware6_api_base/typed_click.py

@@ -0,0 +1,34 @@
+"""Strictly-typed wrappers for rich_click decorators with partially-unknown types.
+
+rich_click ships ``py.typed`` but re-exports click's decorators, whose
+``ParamType[Unknown]`` parameters make pyright (strict mode) report
+``reportUnknownMemberType`` at every call site. Wrapping the affected decorators
+here behind explicit, fully-known signatures keeps the rest of the code
+strict-clean without disabling the rule. This module is the single boundary that
+touches the untyped surface, so the only ``# pyright: ignore`` for this gap lives here.
+"""
+
+from collections.abc import Callable
+from typing import Any
+
+import rich_click as click
+
+_CommandDecorator = Callable[[Callable[..., Any]], Callable[..., Any]]
+
+
+def option(*param_decls: str, **attrs: Any) -> _CommandDecorator:
+    """Typed wrapper over :func:`rich_click.option`. See module docstring."""
+    return click.option(*param_decls, **attrs)  # pyright: ignore[reportUnknownMemberType]
+
+
+def version_option(*param_decls: str, **attrs: Any) -> _CommandDecorator:
+    """Typed wrapper over :func:`rich_click.version_option`. See module docstring."""
+    return click.version_option(*param_decls, **attrs)  # pyright: ignore[reportUnknownMemberType]
+
+
+def argument(*param_decls: str, **attrs: Any) -> _CommandDecorator:
+    """Typed wrapper over :func:`rich_click.argument`. See module docstring."""
+    return click.argument(*param_decls, **attrs)  # pyright: ignore[reportUnknownMemberType]
+
+
+__all__ = ["argument", "option", "version_option"]

{lib_shopware6_api_base-6.0.0 → lib_shopware6_api_base-6.0.2}/tests/test_cli.py

@@ -246,6 +246,61 @@ class TestExitCodeMapping:
         # lib_cli_exit_tools returns 1 for generic exceptions
         assert exit_code == 1
 
+    @pytest.mark.os_agnostic
+    def test_error_prints_diagnostic_message(self, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]) -> None:
+        """A live error must print its message - run_cli's custom handler used to swallow it."""
+        import lib_cli_exit_tools
+
+        from lib_shopware6_api_base.exit_codes import ExitCode
+        from lib_shopware6_api_base.lib_shopware6_api_base_cli import _get_exit_code
+
+        # pin the terse format so the assertion does not depend on a leaked global --traceback state
+        monkeypatch.setattr(lib_cli_exit_tools.config, "traceback", False)
+        try:
+            raise ValueError("diagnostic_marker_42")
+        except ValueError as exc:
+            code = _get_exit_code(exc)
+        captured = capsys.readouterr()
+        assert code == ExitCode.INVALID_ARGUMENT
+        assert "diagnostic_marker_42" in (captured.out + captured.err)
+
+    @pytest.mark.os_agnostic
+    def test_configuration_error_prints_message(
+        self, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
+    ) -> None:
+        """A domain exception must also print its diagnostic, not just map an exit code."""
+        import lib_cli_exit_tools
+
+        from lib_shopware6_api_base.conf_shopware6_api_base_classes import ConfigurationError
+        from lib_shopware6_api_base.exit_codes import ExitCode
+        from lib_shopware6_api_base.lib_shopware6_api_base_cli import _get_exit_code
+
+        monkeypatch.setattr(lib_cli_exit_tools.config, "traceback", False)
+        try:
+            raise ConfigurationError("config_marker_99")
+        except ConfigurationError as exc:
+            code = _get_exit_code(exc)
+        captured = capsys.readouterr()
+        assert code == ExitCode.CONFIGURATION_ERROR
+        assert "config_marker_99" in (captured.out + captured.err)
+
+    @pytest.mark.os_agnostic
+    def test_signal_exit_is_quiet(self, capsys: pytest.CaptureFixture[str]) -> None:
+        """Signals exit cleanly with no printed traceback, even with an active exception."""
+        import lib_cli_exit_tools
+
+        from lib_shopware6_api_base.exit_codes import ExitCode
+        from lib_shopware6_api_base.lib_shopware6_api_base_cli import _get_exit_code
+
+        try:
+            raise lib_cli_exit_tools.SigIntInterrupt()
+        except lib_cli_exit_tools.SigIntInterrupt as exc:
+            code = _get_exit_code(exc)
+        captured = capsys.readouterr()
+        assert code == ExitCode.SIGINT
+        assert captured.out == ""
+        assert captured.err == ""
+
 
 # Keep the original test for backward compatibility
 def test_cli_commands() -> None: