oaknut-cli 13.4.0__tar.gz → 13.6.0__tar.gz

{oaknut_cli-13.4.0/src/oaknut_cli.egg-info → oaknut_cli-13.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oaknut-cli
-Version: 13.4.0
+Version: 13.6.0
 Summary: Shared CLI toolkit for the oaknut family: the contributed-command axis and report-rendering helpers a disc command needs, below the filesystem packages.
 Author-email: Robert Smallshire <robert@smallshire.org.uk>
 License-Expression: MIT
@@ -12,11 +12,10 @@ Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: System :: Filesystems
-Requires-Python: >=3.11
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: oaknut-exception>=10.0

{oaknut_cli-13.4.0 → oaknut_cli-13.6.0}/pyproject.toml

@@ -10,14 +10,13 @@ description = "Shared CLI toolkit for the oaknut family: the contributed-command
 readme = "README.md"
 license = "MIT"
 license-files = ["LICENSE"]
-requires-python = ">=3.11"
+requires-python = ">=3.12"
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Topic :: System :: Filesystems",

{oaknut_cli-13.4.0 → oaknut_cli-13.6.0}/src/oaknut/cli/__init__.py

@@ -11,7 +11,9 @@ It provides:
   registered by filesystem packages on the ``oaknut.command`` entry-point
   namespace (see :func:`contributed_commands`); and
 - report-rendering helpers shared between the generic ``disc`` commands
-  and the contributed ones.
+  and the contributed ones; and
+- the ``--meta-format`` choice type the host-boundary commands of
+  ``disc`` and ``zip`` share (see :class:`MetaFormatChoice`).
 
 See ``docs/dev/contributed-commands.md`` for the design.
 """
@@ -28,6 +30,7 @@ from oaknut.cli.help import (
     strip_rst,
     use_plain_help,
 )
+from oaknut.cli.meta_format import META_FORMAT_NONE, MetaFormatChoice
 from oaknut.cli.reports import (
     SECTOR_SIZE,
     address_cell,
@@ -40,7 +43,7 @@ from oaknut.cli.reports import (
     text_cell,
 )
 
-__version__ = "13.4.0"
+__version__ = "13.6.0"
 
 __all__ = [
     "COMMAND_KIND",
@@ -49,6 +52,8 @@ __all__ = [
     "PlainHelpFormatter",
     "strip_rst",
     "use_plain_help",
+    "META_FORMAT_NONE",
+    "MetaFormatChoice",
     "SECTOR_SIZE",
     "address_cell",
     "bytes_cell",

oaknut_cli-13.6.0/src/oaknut/cli/meta_format.py

@@ -0,0 +1,34 @@
+"""The ``--meta-format`` choice shared by every host-boundary command."""
+
+from __future__ import annotations
+
+import click
+from oaknut.file import DEPRECATED_META_FORMATS, MetaFormat
+
+#: The choice meaning "carry no metadata", alongside the MetaFormat values.
+META_FORMAT_NONE = "none"
+
+
+class MetaFormatChoice(click.Choice):
+    """A case-insensitive choice of :class:`~oaknut.file.MetaFormat` values or ``none``.
+
+    The choices follow :class:`~oaknut.file.MetaFormat`, so a new format
+    reaches every command at once. A deprecated name from
+    :data:`~oaknut.file.DEPRECATED_META_FORMATS` is accepted, with a
+    warning on stderr, and converts to the name that replaces it; it is
+    not listed in help.
+    """
+
+    def __init__(self) -> None:
+        super().__init__([*(f.value for f in MetaFormat), META_FORMAT_NONE], case_sensitive=False)
+
+    def convert(self, value, param, ctx):
+        if isinstance(value, str):
+            replacement = DEPRECATED_META_FORMATS.get(value.lower())
+            if replacement is not None:
+                click.echo(
+                    f"warning: --meta-format {value} is deprecated; use {replacement.value}.",
+                    err=True,
+                )
+                value = replacement.value
+        return super().convert(value, param, ctx)

{oaknut_cli-13.4.0 → oaknut_cli-13.6.0/src/oaknut_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oaknut-cli
-Version: 13.4.0
+Version: 13.6.0
 Summary: Shared CLI toolkit for the oaknut family: the contributed-command axis and report-rendering helpers a disc command needs, below the filesystem packages.
 Author-email: Robert Smallshire <robert@smallshire.org.uk>
 License-Expression: MIT
@@ -12,11 +12,10 @@ Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: System :: Filesystems
-Requires-Python: >=3.11
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: oaknut-exception>=10.0

{oaknut_cli-13.4.0 → oaknut_cli-13.6.0}/src/oaknut_cli.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ pyproject.toml
 src/oaknut/cli/__init__.py
 src/oaknut/cli/commands.py
 src/oaknut/cli/help.py
+src/oaknut/cli/meta_format.py
 src/oaknut/cli/reports.py
 src/oaknut_cli.egg-info/PKG-INFO
 src/oaknut_cli.egg-info/SOURCES.txt
@@ -12,4 +13,5 @@ src/oaknut_cli.egg-info/requires.txt
 src/oaknut_cli.egg-info/top_level.txt
 tests/test_commands.py
 tests/test_help.py
+tests/test_meta_format.py
 tests/test_reports.py

oaknut_cli-13.6.0/tests/test_meta_format.py

@@ -0,0 +1,49 @@
+"""Tests for the --meta-format choice type."""
+
+import click
+from click.testing import CliRunner
+from oaknut.cli import MetaFormatChoice
+from oaknut.file import MetaFormat
+
+
+def _cli():
+    @click.command()
+    @click.option("--meta-format", type=MetaFormatChoice(), default="inf-trad")
+    def show(meta_format):
+        click.echo(meta_format)
+
+    return show
+
+
+class TestMetaFormatChoice:
+    def test_choices_are_every_format_and_none(self):
+        assert list(MetaFormatChoice().choices) == [*(f.value for f in MetaFormat), "none"]
+
+    def test_deprecated_names_are_not_listed(self):
+        assert "filename-mos" not in MetaFormatChoice().choices
+
+    def test_accepts_a_current_name(self):
+        result = CliRunner().invoke(_cli(), ["--meta-format", "filename-loadexec"])
+        assert result.exit_code == 0
+        assert result.stdout == "filename-loadexec\n"
+
+    def test_accepts_none(self):
+        result = CliRunner().invoke(_cli(), ["--meta-format", "none"])
+        assert result.exit_code == 0
+        assert result.stdout == "none\n"
+
+    def test_is_case_insensitive(self):
+        result = CliRunner().invoke(_cli(), ["--meta-format", "INF-PIEB"])
+        assert result.exit_code == 0
+        assert result.stdout == "inf-pieb\n"
+
+    def test_deprecated_name_resolves_and_warns(self):
+        result = CliRunner().invoke(_cli(), ["--meta-format", "filename-mos"])
+        assert result.exit_code == 0
+        assert result.stdout == "filename-loadexec\n"
+        assert "deprecated" in result.stderr
+        assert "filename-loadexec" in result.stderr
+
+    def test_rejects_an_unknown_name(self):
+        result = CliRunner().invoke(_cli(), ["--meta-format", "filename-nfs"])
+        assert result.exit_code == 2