derivepassphrase.git

Move CLI messages module into a new `_internals` subpackage
Parent 2589294
Marco Ricci

Marco Ricci commited on 2025-01-29 20:34:40
Zeige 11 geänderte Dateien mit 31 Einfügungen und 15 Löschungen. 

Also adjust the headings in the development build of the documentation
to clearly mark internal documentation as internal.

(The absolute imports within the CLI messages module make the move
itself relatively painless: only the callers need to be adjusted to the
new path.)
docs/reference/derivepassphrase._internals.cli_messages.md
Zeige Datei @ 733aeec
... ... 
@@ -0,0 +1,3 @@
1 
+::: derivepassphrase._internals.cli_messages
2 
+    options:
3 
+      heading_level: 1
docs/reference/derivepassphrase.cli.msg.md
Zeige Datei @ 2589294
... ... 
@@ -1,3 +0,0 @@
1 
-::: derivepassphrase._cli_msg
2 
-    options:
3 
-      heading_level: 1
docs/reference/index.md
Zeige Datei @ 733aeec
... ... 
@@ -13,7 +13,6 @@ title: Reference overview
13 13
14 14 
 * `derivepassphrase`: Work-alike for vault(1) – deterministic, stateless password manager.
15 15 
     * [`derivepassphrase.cli`][]: Command-line interface for `derivepassphrase`.
16 
-        * [`derivepassphrase._cli_msg`][]: Messages for the command-line interface of `derivepassphrase`.
17 16 
     * [`derivepassphrase.exporter`][]: Exporter for other passphrase generator configurations.
18 17 
         * [`derivepassphrase.exporter.storeroom`][]: Exporter for the vault "storeroom" configuration format.
19 18 
         * [`derivepassphrase.exporter.vault_native`][]: Exporter for the vault native configuration formats (v0.2 and v0.3).
mkdocs.yml
Zeige Datei @ 733aeec
... ... 
@@ -104,9 +104,7 @@ nav:
104 104 
       - 'derivepassphrase-export(1)': reference/derivepassphrase-export.1.md
105 105 
       - 'derivepassphrase-export-vault(1)': reference/derivepassphrase-export-vault.1.md
106 106 
     - 'API docs: Module derivepassphrase':
107 
-      - Subpackage cli:
108 
-        - Module cli: reference/derivepassphrase.cli.md
109 
-        - Virtual submodule _cli_msg: reference/derivepassphrase.cli.msg.md
107 
+      - Submodule cli: reference/derivepassphrase.cli.md
110 108 
       - Subpackage exporter: reference/derivepassphrase.exporter.md
111 109 
       - Submodule sequin: reference/derivepassphrase.sequin.md
112 110 
       - Submodule ssh_agent: reference/derivepassphrase.ssh_agent.md
mkdocs_devsetup.yml
Zeige Datei @ 733aeec
... ... 
@@ -20,9 +20,7 @@ nav:
20 20 
       - 'derivepassphrase-export(1)': reference/derivepassphrase-export.1.md
21 21 
       - 'derivepassphrase-export-vault(1)': reference/derivepassphrase-export-vault.1.md
22 22 
     - 'API docs: Module derivepassphrase':
23 
-      - Subpackage cli:
24 
-        - Module cli: reference/derivepassphrase.cli.md
25 
-        - Virtual submodule _cli_msg: reference/derivepassphrase.cli.msg.md
23 
+      - Submodule cli: reference/derivepassphrase.cli.md
26 24 
       - Subpackage exporter: reference/derivepassphrase.exporter.md
27 25 
       - Submodule sequin: reference/derivepassphrase.sequin.md
28 26 
       - Submodule ssh_agent: reference/derivepassphrase.ssh_agent.md
... ... 
@@ -30,7 +28,9 @@ nav:
30 28 
       - Submodule vault: reference/derivepassphrase.vault.md
31 29 
     - Technical prerequisites:
32 30 
       - 'Using derivepassphrase vault with an SSH key': reference/prerequisites-ssh-key.md
33 
-    - Tests:
31 
+    - 'Internal API docs: Submodule derivepassphrase._internals':
32 
+      - Submodule cli_messages: reference/derivepassphrase._internals.cli_messages.md
33 
+    - 'Internal API docs: Tests':
34 34 
       - Basic testing infrastructure: reference/tests.md
35 35 
       - Localization machinery: reference/tests.test_l10n.md
36 36 
       - derivepassphrase command-line:
src/derivepassphrase/_internals/__init__.py
Zeige Datei @ 733aeec
... ... 
@@ -0,0 +1,19 @@
1 
+# SPDX-FileCopyrightText: 2025 Marco Ricci <software@the13thletter.info>
2 
+#
3 
+# SPDX-License-Identifier: Zlib
4 
+
5 
+"""derivepassphrase internals.
6 
+
7 
+Warning:
8 
+    Non-public package (implementation detail), provided for didactical
9 
+    and educational purposes only. Subject to change without notice,
10 
+    including removal.
11 
+
12 
+"""
13 
+
14 
+import derivepassphrase
15 
+
16 
+__author__ = derivepassphrase.__author__
17 
+__version__ = derivepassphrase.__version__
18 
+
19 
+__all__ = ()
src/derivepassphrase/_cli_msg.py
Zeige Datei @ 733aeec
src/derivepassphrase/cli.py
Zeige Datei @ 733aeec
... ... 
@@ -42,8 +42,8 @@ from typing_extensions import (
42 42 
 )
43 43
44 44 
 import derivepassphrase as dpp
45 
-from derivepassphrase import _cli_msg as _msg
46 45 
 from derivepassphrase import _types, exporter, ssh_agent, vault
46 
+from derivepassphrase._internals import cli_messages as _msg
47 47
48 48 
 if sys.version_info >= (3, 11):
49 49 
     import tomllib
src/derivepassphrase/exporter/storeroom.py
Zeige Datei @ 733aeec
... ... 
@@ -34,7 +34,7 @@ import pathlib
34 34 
 import struct
35 35 
 from typing import TYPE_CHECKING, Any
36 36
37 
-from derivepassphrase import _cli_msg as _msg
37 
+from derivepassphrase._internals import cli_messages as _msg
38 38 
 from derivepassphrase import _types, exporter
39 39
40 40 
 if TYPE_CHECKING:
src/derivepassphrase/exporter/vault_native.py
Zeige Datei @ 733aeec
... ... 
@@ -35,7 +35,7 @@ import pathlib
35 35 
 import warnings
36 36 
 from typing import TYPE_CHECKING
37 37
38 
-from derivepassphrase import _cli_msg as _msg
38 
+from derivepassphrase._internals import cli_messages as _msg
39 39 
 from derivepassphrase import exporter, vault
40 40
41 41 
 if TYPE_CHECKING:
tests/test_l10n.py
Zeige Datei @ 733aeec
... ... 
@@ -18,7 +18,7 @@ import hypothesis
18 18 
 import pytest
19 19 
 from hypothesis import strategies
20 20
21 
-from derivepassphrase import _cli_msg as msg
21 
+from derivepassphrase._internals import cli_messages as msg
22 22
23 23 
 if TYPE_CHECKING:
24 24 
     from collections.abc import Iterator
25 25