bitranox-template-py-cli 2.1.3__tar.gz → 2.2.0__tar.gz

{bitranox_template_py_cli-2.1.3 → bitranox_template_py_cli-2.2.0}/CHANGELOG.md

@@ -6,6 +6,19 @@ the [Keep a Changelog](https://keepachangelog.com/) format.
 
 ## [Unreleased]
 
+## [2.2.0] 2026-10-08 13:56:49
+
+### Removed
+- **`send-notification --raise-on-missing-attachments` (usage change).** A notification takes no
+  attachments, so the switch did nothing there. `send-notification` now refuses it as an unknown
+  option (exit 2); `send-email` keeps it. Drop the flag from any script that passes it to
+  `send-notification`.
+
+### Tests
+- The `config-deploy --force` report for a deploy in which every target file is already identical
+  is covered end to end. New shared fixture `user_layer_in_tmp_path` points every OS's user-layer
+  location at `tmp_path`; it replaces two hand-written copies of the same loop.
+
 ## [2.1.3] 2026-10-08 11:57:40
 
 ### Fixed

{bitranox_template_py_cli-2.1.3 → bitranox_template_py_cli-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: bitranox_template_py_cli
-Version: 2.1.3
+Version: 2.2.0
 Summary: Template CLI application with configuration management and structured logging
 Project-URL: Homepage, https://github.com/bitranox/bitranox_template_py_cli
 Project-URL: Repository, https://github.com/bitranox/bitranox_template_py_cli.git

{bitranox_template_py_cli-2.1.3 → bitranox_template_py_cli-2.2.0}/docs/systemdesign/module_reference.md

@@ -251,22 +251,18 @@ Send email using configured SMTP settings.
 
 Send simple plain-text notification email.
 
-| Option                                                               | Description                          |
-|----------------------------------------------------------------------|--------------------------------------|
-| `--to ADDRESS`                                                       | Recipient (repeatable)               |
-| `--subject TEXT`                                                     | Subject  -  required                 |
-| `--message TEXT`                                                     | Message  -  required                 |
-| `--from ADDRESS`                                                     | Override sender                      |
-| `--smtp-host HOST:PORT`                                              | Override SMTP host (repeatable)      |
-| `--smtp-username USER`                                               | Override username                    |
-| `--smtp-password PASS`                                               | Override password                    |
-| `--use-starttls / --no-use-starttls`                                 | Override STARTTLS                    |
-| `--timeout SECONDS`                                                  | Override timeout                     |
-| `--raise-on-missing-attachments / --no-raise-on-missing-attachments` | Override missing-attachment handling |
-| `--raise-on-invalid-recipient / --no-raise-on-invalid-recipient`     | Override invalid-recipient handling  |
-
-`--raise-on-missing-attachments` is accepted for symmetry with `send-email`, but a notification
-carries no attachments, so it has no effect.
+| Option                                                           | Description                         |
+|------------------------------------------------------------------|-------------------------------------|
+| `--to ADDRESS`                                                   | Recipient (repeatable)              |
+| `--subject TEXT`                                                 | Subject  -  required                |
+| `--message TEXT`                                                 | Message  -  required                |
+| `--from ADDRESS`                                                 | Override sender                     |
+| `--smtp-host HOST:PORT`                                          | Override SMTP host (repeatable)     |
+| `--smtp-username USER`                                           | Override username                   |
+| `--smtp-password PASS`                                           | Override password                   |
+| `--use-starttls / --no-use-starttls`                             | Override STARTTLS                   |
+| `--timeout SECONDS`                                              | Override timeout                    |
+| `--raise-on-invalid-recipient / --no-raise-on-invalid-recipient` | Override invalid-recipient handling |
 
 **Exit codes:** 0, 2 (usage error), 22 (invalid option value), 69 (SMTP failure), 78 (no SMTP hosts, an invalid `[email]` section, or configuration not loadable)
 
@@ -425,16 +421,17 @@ Use `composition.build_testing()` to wire all in-memory adapters. It wires the r
 
 ### Test Fixtures (conftest.py)
 
-| Fixture                   | Purpose                                                                                                               |
-|---------------------------|-----------------------------------------------------------------------------------------------------------------------|
-| `config_factory`          | Creates real `Config` instances from test data                                                                        |
-| `inject_config`           | Injects config into CLI path                                                                                          |
-| `cli_runner`              | Fresh `CliRunner` per test                                                                                            |
-| `strip_ansi`              | Strips ANSI escape codes from output                                                                                  |
-| `clear_config_cache`      | Clears LRU cache before tests                                                                                         |
-| `managed_traceback_state` | Resets/restores traceback configuration                                                                               |
-| `isolated_logging_state`  | Autouse: after every test, shuts the lib_log_rich runtime down and restores the root logger; yields that restore step |
+| Fixture                   | Purpose                                                                                                                                                                 |
+|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `config_factory`          | Creates real `Config` instances from test data                                                                                                                          |
+| `inject_config`           | Injects config into CLI path                                                                                                                                            |
+| `cli_runner`              | Fresh `CliRunner` per test                                                                                                                                              |
+| `strip_ansi`              | Strips ANSI escape codes from output                                                                                                                                    |
+| `clear_config_cache`      | Clears LRU cache before tests                                                                                                                                           |
+| `managed_traceback_state` | Resets/restores traceback configuration                                                                                                                                 |
+| `isolated_logging_state`  | Autouse: after every test, shuts the lib_log_rich runtime down and restores the root logger; yields that restore step                                                   |
+| `user_layer_in_tmp_path`  | Points every OS's user-layer location (`HOME`, `USERPROFILE`, `XDG_CONFIG_HOME`, `APPDATA`, `LOCALAPPDATA`) at `tmp_path` and returns it, so a real deploy writes there |
 
 ---
 
-**Last Updated:** 2026-10-06 (file index, CLI options and public names brought in line with the source tree)
+**Last Updated:** 2026-10-08 (`send-notification` options, test fixtures)

{bitranox_template_py_cli-2.1.3 → bitranox_template_py_cli-2.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "bitranox_template_py_cli"
-version = "2.1.3"
+version = "2.2.0"
 description = "Template CLI application with configuration management and structured logging"
 readme = "README.md"
 requires-python = ">=3.10"

{bitranox_template_py_cli-2.1.3 → bitranox_template_py_cli-2.2.0}/src/bitranox_template_py_cli/__init__conf__.py

@@ -40,7 +40,7 @@ name = "bitranox_template_py_cli"
 #: Human-readable summary shown in CLI help output.
 title = "Template CLI application with configuration management and structured logging"
 #: Current release version pulled from ``pyproject.toml`` by automation.
-version = "2.1.3"
+version = "2.2.0"
 #: Repository homepage presented to users.
 homepage = "https://github.com/bitranox/bitranox_template_py_cli"
 #: Author attribution surfaced in CLI output.

{bitranox_template_py_cli-2.1.3 → bitranox_template_py_cli-2.2.0}/src/bitranox_template_py_cli/adapters/cli/commands/email/_common.py

@@ -84,9 +84,10 @@ def smtp_config_options(func: Callable[..., Any]) -> Callable[..., Any]:
     """Apply shared SMTP configuration override options to a Click command.
 
     Adds CLI flags for the SMTP connection and delivery settings (hosts, credentials,
-    STARTTLS, timeout, the two raise_on_* switches). ``starttls_verify``,
-    ``local_hostname``, ``delivery_deadline``, ``recipient_max_count`` and the attachment
-    settings have no flag; set them with ``--set email.<key>=...``.
+    STARTTLS, timeout, ``raise_on_invalid_recipient``). ``send-email`` adds its own
+    ``--raise-on-missing-attachments`` switch, since only it takes attachments.
+    ``starttls_verify``, ``local_hostname``, ``delivery_deadline``, ``recipient_max_count``
+    and the attachment settings have no flag; set them with ``--set email.<key>=...``.
     """
     options = [
         option(
@@ -100,11 +101,6 @@ def smtp_config_options(func: Callable[..., Any]) -> Callable[..., Any]:
         option("--smtp-password", default=None, help="Override SMTP authentication password"),
         option("--use-starttls/--no-use-starttls", default=None, help="Override STARTTLS setting"),
         option("--timeout", "timeout", type=float, default=None, help="Override socket timeout in seconds"),
-        option(
-            "--raise-on-missing-attachments/--no-raise-on-missing-attachments",
-            default=None,
-            help="Override missing attachment handling",
-        ),
         option(
             "--raise-on-invalid-recipient/--no-raise-on-invalid-recipient",
             default=None,

{bitranox_template_py_cli-2.1.3 → bitranox_template_py_cli-2.2.0}/src/bitranox_template_py_cli/adapters/cli/commands/email/send_email.py

@@ -73,6 +73,11 @@ def _log_send_email_start(
     type=click.Path(path_type=str),
     help="File to attach (can specify multiple)",
 )
+@option(
+    "--raise-on-missing-attachments/--no-raise-on-missing-attachments",
+    default=None,
+    help="Override missing attachment handling",
+)
 @smtp_config_options
 @click.pass_context
 def cli_send_email(

{bitranox_template_py_cli-2.1.3 → bitranox_template_py_cli-2.2.0}/src/bitranox_template_py_cli/adapters/cli/commands/email/send_notification.py

@@ -53,7 +53,6 @@ def cli_send_notification(
     smtp_password: str | None,
     use_starttls: bool | None,
     timeout: float | None,
-    raise_on_missing_attachments: bool | None,
     raise_on_invalid_recipient: bool | None,
 ) -> None:
     """Send a simple plain-text notification email.
@@ -77,7 +76,6 @@ def cli_send_notification(
             smtp_password=smtp_password,
             smtp_use_starttls=use_starttls,
             smtp_timeout=timeout,
-            raise_on_missing_attachments=raise_on_missing_attachments,
             raise_on_invalid_recipient=raise_on_invalid_recipient,
         )
         try:

{bitranox_template_py_cli-2.1.3 → bitranox_template_py_cli-2.2.0}/tests/conftest.py

@@ -212,6 +212,18 @@ def production_factory() -> Callable[[], AppServices]:
     return build_production
 
 
+@pytest.fixture
+def user_layer_in_tmp_path(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> Path:
+    """Point every OS's user-layer location at ``tmp_path`` and return it.
+
+    A deploy then writes under ``tmp_path`` rather than into the real user configuration
+    directory, and the developer's own user-layer files cannot decide a result.
+    """
+    for name in ("HOME", "USERPROFILE", "XDG_CONFIG_HOME", "APPDATA", "LOCALAPPDATA"):
+        monkeypatch.setenv(name, str(tmp_path))
+    return tmp_path
+
+
 @pytest.fixture
 def strip_ansi() -> Callable[[str], str]:
     """Return a helper that strips ANSI escape sequences from a string.

{bitranox_template_py_cli-2.1.3 → bitranox_template_py_cli-2.2.0}/tests/test_cli_config.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from pathlib import Path
 from typing import TYPE_CHECKING, Any
 
 import pytest
@@ -11,7 +12,6 @@ from bitranox_template_py_cli.adapters.config import loader as config_mod
 
 if TYPE_CHECKING:
     from collections.abc import Callable, Mapping
-    from pathlib import Path
 
     from click.testing import CliRunner, Result
     from lib_layered_config import Config
@@ -257,6 +257,27 @@ def test_when_config_deploy_finds_no_files_to_create_it_informs_user(
     assert "--force" in result.output
 
 
+@pytest.mark.os_agnostic
+def test_when_a_forced_config_deploy_finds_every_file_identical_it_says_nothing_was_written(
+    cli_runner: CliRunner,
+    production_factory: Callable[[], Any],
+    user_layer_in_tmp_path: Path,
+) -> None:
+    """A second forced deploy writes nothing, and does not suggest the --force it was given."""
+    command = ["config-deploy", "--target", "user", "--force"]
+    first: Result = cli_runner.invoke(cli_mod.cli, command, obj=production_factory)
+    written = [Path(line.removeprefix("  + ")) for line in first.output.splitlines() if line.startswith("  + ")]
+    assert first.exit_code == 0
+    assert written  # liveness: the first deploy writes the files the second one finds identical
+    assert all(path.resolve().is_relative_to(user_layer_in_tmp_path.resolve()) for path in written)
+
+    second: Result = cli_runner.invoke(cli_mod.cli, command, obj=production_factory)
+
+    assert second.exit_code == 0
+    assert "No files were written: every target file is already identical" in second.output
+    assert "--force" not in second.output
+
+
 @pytest.mark.os_agnostic
 def test_when_config_deploy_encounters_permission_error_it_handles_gracefully(
     cli_runner: CliRunner,

{bitranox_template_py_cli-2.1.3 → bitranox_template_py_cli-2.2.0}/tests/test_cli_email.py

@@ -548,6 +548,45 @@ def test_when_send_notification_receives_smtp_host_override_it_uses_it(
     assert ctx.spy.sent_notifications[0].config.smtphosts == ["smtp.override.com:465"]
 
 
+@pytest.mark.os_agnostic
+@pytest.mark.parametrize("flag", ["--raise-on-missing-attachments", "--no-raise-on-missing-attachments"])
+def test_when_send_notification_receives_a_missing_attachments_flag_it_refuses_the_option(
+    cli_runner: CliRunner,
+    email_cli_context: Callable[[dict[str, Any]], EmailCliContext],
+    flag: str,
+) -> None:
+    """send-notification takes no attachments, so it offers no missing-attachment switch."""
+    ctx = email_cli_context({"smtp_hosts": ["smtp.test.com:587"], "from_address": "alerts@test.com"})
+
+    result: Result = cli_runner.invoke(
+        cli_mod.cli,
+        ["send-notification", "--to", "admin@test.com", "--subject", "Alert", "--message", "Hi", flag],
+        obj=ctx.factory,
+    )
+
+    assert result.exit_code == 2
+    assert "No such option" in result.output
+    assert ctx.spy.sent_notifications == []
+
+
+@pytest.mark.os_agnostic
+def test_when_send_email_receives_no_raise_on_missing_attachments_it_overrides_the_config(
+    cli_runner: CliRunner,
+    email_cli_context: Callable[[dict[str, Any]], EmailCliContext],
+) -> None:
+    """send-email keeps the switch: --no-raise-on-missing-attachments reaches the delivery config."""
+    ctx = email_cli_context({"smtp_hosts": ["smtp.test.com:587"], "from_address": "sender@test.com"})
+
+    result: Result = cli_runner.invoke(
+        cli_mod.cli,
+        ["send-email", "--to", "r@test.com", "--subject", "S", "--body", "B", "--no-raise-on-missing-attachments"],
+        obj=ctx.factory,
+    )
+
+    assert result.exit_code == 0
+    assert ctx.spy.sent_emails[0].config.raise_on_missing_attachments is False
+
+
 # ======================== Attachment path validation ========================
 
 

{bitranox_template_py_cli-2.1.3 → bitranox_template_py_cli-2.2.0}/tests/test_email_password_secrecy.py

@@ -92,15 +92,12 @@ def test_an_all_digit_password_is_read_as_its_digits() -> None:
 
 @pytest.mark.os_agnostic
 def test_an_all_digit_password_from_the_environment_loads(
-    monkeypatch: pytest.MonkeyPatch, tmp_path: Path, clear_config_cache: None
+    monkeypatch: pytest.MonkeyPatch, user_layer_in_tmp_path: Path, clear_config_cache: None
 ) -> None:
     """Through the real loader: the environment layer turns the digits into an int."""
     prefix = __init__conf__.LAYEREDCONF_SLUG.upper().replace("-", "_")
     monkeypatch.setenv(f"{prefix}___EMAIL__SMTP_PASSWORD", DIGITS)
-    # Every OS's user-layer location, so a developer's own config cannot decide the result.
-    for name in ("HOME", "USERPROFILE", "XDG_CONFIG_HOME", "APPDATA", "LOCALAPPDATA"):
-        monkeypatch.setenv(name, str(tmp_path))
-    config = build_production().get_config(dotenv_path=str(tmp_path / "absent.env"))
+    config = build_production().get_config(dotenv_path=str(user_layer_in_tmp_path / "absent.env"))
 
     assert config.get("email", {}).get("smtp_password") == int(DIGITS)
     assert load_email_config_from_dict(config.as_dict()).smtp_password == SecretStr(DIGITS)

{bitranox_template_py_cli-2.1.3 → bitranox_template_py_cli-2.2.0}/tests/test_permission_defaults.py

@@ -192,14 +192,12 @@ def test_no_permissions_with_a_mode_is_a_usage_error(
 
 
 @pytest.fixture
-def real_deploy(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> Callable[[], AppServices]:
+def real_deploy(user_layer_in_tmp_path: Path) -> Callable[[], AppServices]:
     """The testing composition with the production deploy, every user-layer location under ``tmp_path``.
 
     The refusals below happen before anything is written; should one ever be accepted, the
     deploy lands in ``tmp_path`` rather than in the real user configuration directory.
     """
-    for name in ("HOME", "USERPROFILE", "XDG_CONFIG_HOME", "APPDATA", "LOCALAPPDATA"):
-        monkeypatch.setenv(name, str(tmp_path))
     return lambda: dataclasses.replace(build_testing(), deploy_configuration=deploy_configuration)