derivepassphrase.git

@@ -291,7 +291,9 @@ class _VaultConfigValidator:

             kwargs['key'] = key

             kwargs['value'] = value

             kwargs['json_path_str'] = json_path([*path, key])

-            # Use match/case here once Python 3.9 becomes unsupported.

+            # TODO(the-13th-letter): Rewrite using structural pattern

+            # matching.

+            # https://the13thletter.info/derivepassphrase/latest/pycompatibility/#after-eol-py3.9

             if key in {'key', 'phrase'}:

                 if not isinstance(value, str):

                     raise TypeError(err_not_a_string.format(**kwargs))

@@ -353,7 +355,9 @@ class _VaultConfigValidator:

         for path, key, value in self.walk_subconfigs():

             service_obj = self.traverse_path(path)

-            # Use match/case here once Python 3.9 becomes unsupported.

+            # TODO(the-13th-letter): Rewrite using structural pattern

+            # matching.

+            # https://the13thletter.info/derivepassphrase/latest/pycompatibility/#after-eol-py3.9

             if key == 'phrase' and falsy_but_not_string(value):

                 yield CleanupStep(

                     (*path, key), service_obj[key], 'replace', ''

@@ -454,6 +458,8 @@ def validate_vault_config(

             specified `derivepassphrase` extensions.

     """

+    # TODO(the-13th-letter): Remove this block in v1.0.

+    # https://the13thletter.info/derivepassphrase/latest/upgrade-notes/#v1.0-allow-derivepassphrase-extensions

     # TODO(the-13th-letter): Add tests that trigger the deprecation warning,

     # then include this in coverage.

     if not isinstance(

@@ -593,6 +599,8 @@ def clean_up_falsy_vault_config_values(

         return None

+# TODO(the-13th-letter): Use type variables local to each class.

+# https://the13thletter.info/derivepassphrase/latest/pycompatibility/#after-eol-py3.11

 T_Buffer = TypeVar('T_Buffer', bound=Buffer)

 """

 A [`TypeVar`][] for classes implementing the [`Buffer`][] interface.

@@ -1111,6 +1111,9 @@ if (

 #     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR

 #     OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

 #     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

+#

+# TODO(the-13th-letter): Remove this class and license block in v1.0.

+# https://the13thletter.info/derivepassphrase/latest/upgrade-notes/#v1.0-implied-subcommands

 class _DefaultToVaultGroup(CommandWithHelpGroups, click.Group):

     """A helper class to implement the default-to-"vault"-subcommand behavior.

@@ -1166,6 +1169,9 @@ class _DefaultToVaultGroup(CommandWithHelpGroups, click.Group):

         return cmd_name if cmd else None, cmd, args[1:]

+# TODO(the-13th-letter): Base this class on CommandWithHelpGroups and

+# click.Group in v1.0.

+# https://the13thletter.info/derivepassphrase/latest/upgrade-notes/#v1.0-implied-subcommands

 class _TopLevelCLIEntryPoint(_DefaultToVaultGroup):

     """A minor variation of _DefaultToVaultGroup for the top-level command.

@@ -1227,6 +1233,8 @@ def derivepassphrase(ctx: click.Context, /) -> None:

     [CLICK]: https://pypi.org/package/click/

     """

+    # TODO(the-13th-letter): Turn this callback into a no-op in v1.0.

+    # https://the13thletter.info/derivepassphrase/latest/upgrade-notes/#v1.0-implied-subcommands

     deprecation = logging.getLogger(f'{PROG_NAME}.deprecation')

     if ctx.invoked_subcommand is None:

         deprecation.warning(

@@ -1280,6 +1288,8 @@ def derivepassphrase_export(ctx: click.Context, /) -> None:

     [CLICK]: https://pypi.org/package/click/

     """

+    # TODO(the-13th-letter): Turn this callback into a no-op in v1.0.

+    # https://the13thletter.info/derivepassphrase/latest/upgrade-notes/#v1.0-implied-subcommands

     deprecation = logging.getLogger(f'{PROG_NAME}.deprecation')

     if ctx.invoked_subcommand is None:

         deprecation.warning(

@@ -1465,6 +1475,8 @@ _config_filename_table = {

     None: '.',

     'vault': 'vault.json',

     'user configuration': 'config.toml',

+    # TODO(the-13th-letter): Remove the old settings.json file.

+    # https://the13thletter.info/derivepassphrase/latest/upgrade-notes.html#v1.0-old-settings-file

     'old settings.json': 'settings.json',

 }

@@ -1535,6 +1547,8 @@ def _load_config() -> _types.VaultConfig:

     return data

+# TODO(the-13th-letter): Remove this function.

+# https://the13thletter.info/derivepassphrase/latest/upgrade-notes.html#v1.0-old-settings-file

 def _migrate_and_load_old_config() -> tuple[

     _types.VaultConfig, OSError | None

 ]:

@@ -44,7 +44,8 @@ class SSHAgentFailedError(RuntimeError):

     """The SSH agent failed to complete the requested operation."""

     def __str__(self) -> str:

-        # Use match/case here once Python 3.9 becomes unsupported.

+        # TODO(the-13th-letter): Rewrite using structural pattern matching.

+        # https://the13thletter.info/derivepassphrase/latest/pycompatibility/#after-eol-py3.9

         if self.args == (  # pragma: no branch

             _types.SSH_AGENT.FAILURE.value,

             b'',

@@ -327,7 +328,8 @@ class SSHAgentClient:

                 setting up a socket connection to the agent.

         """  # noqa: DOC501

-        # Use match/case here once Python 3.9 becomes unsupported.

+        # TODO(the-13th-letter): Rewrite using structural pattern matching.

+        # https://the13thletter.info/derivepassphrase/latest/pycompatibility/#after-eol-py3.9

         if isinstance(conn, SSHAgentClient):

             with contextlib.nullcontext():

                 yield conn

@@ -1433,8 +1433,8 @@ def isolated_config(

 ) -> Iterator[None]:

     prog_name = cli.PROG_NAME

     env_name = prog_name.replace(' ', '_').upper() + '_PATH'

-    # Use parenthesized context manager expressions once Python 3.9

-    # becomes unsupported.

+    # TODO(the-13th-letter): Rewrite using parenthesized with-statements.

+    # https://the13thletter.info/derivepassphrase/latest/pycompatibility/#after-eol-py3.9

     with contextlib.ExitStack() as stack:

         stack.enter_context(runner.isolated_filesystem())

         stack.enter_context(cli.StandardCLILogging.ensure_standard_logging())

@@ -1477,6 +1477,8 @@ def isolated_vault_exporter_config(

     vault_config: str | bytes | None = None,

     vault_key: str | None = None,

 ) -> Iterator[None]:

+    # TODO(the-13th-letter): Remove the fallback implementation.

+    # https://the13thletter.info/derivepassphrase/latest/pycompatibility/#after-eol-py3.10

     if TYPE_CHECKING:

         chdir: Callable[..., AbstractContextManager]

     else:

@@ -1505,13 +1507,15 @@ def isolated_vault_exporter_config(

         if vault_key is not None:

             monkeypatch.setenv('VAULT_KEY', vault_key)

         vault_config_path = pathlib.Path('.vault').resolve()

-        # Use match/case here once Python 3.9 becomes unsupported.

+        # TODO(the-13th-letter): Rewrite using structural pattern matching.

+        # https://the13thletter.info/derivepassphrase/latest/pycompatibility/#after-eol-py3.9

         if isinstance(vault_config, str):

             vault_config_path.write_text(f'{vault_config}\n', encoding='UTF-8')

         elif isinstance(vault_config, bytes):

             vault_config_path.mkdir(parents=True, mode=0o700, exist_ok=True)

-            # Use parenthesized context manager expressions here once

-            # Python 3.9 becomes unsupported.

+            # TODO(the-13th-letter): Rewrite using parenthesized

+            # with-statements.

+            # https://the13thletter.info/derivepassphrase/latest/pycompatibility/#after-eol-py3.9

             with contextlib.ExitStack() as stack:

                 stack.enter_context(chdir(vault_config_path))

                 tmpzipfile = stack.enter_context(

@@ -1647,7 +1651,8 @@ class ReadableResult(NamedTuple):

                 else error.match(line) is not None

             )

-        # Use match/case here once Python 3.9 becomes unsupported.

+        # TODO(the-13th-letter): Rewrite using structural pattern matching.

+        # https://the13thletter.info/derivepassphrase/latest/pycompatibility/#after-eol-py3.9

         if isinstance(error, type):

             return isinstance(self.exception, error)

         else:  # noqa: RET505

@@ -2086,8 +2086,9 @@ class TestCLIUtils:

         self, monkeypatch: pytest.MonkeyPatch

     ) -> None:

         runner = click.testing.CliRunner()

-        # Use parenthesized context manager expressions here once Python

-        # 3.9 becomes unsupported.

+        # TODO(the-13th-letter): Rewrite using parenthesized

+        # with-statements.

+        # https://the13thletter.info/derivepassphrase/latest/pycompatibility/#after-eol-py3.9

         with contextlib.ExitStack() as stack:

             stack.enter_context(

                 tests.isolated_vault_config(

@@ -2632,7 +2633,9 @@ Boo.

                 ssh_agent.SSHAgentClient, 'list_keys', tests.list_keys

             )

             hint: ssh_agent.SSHAgentClient | socket.socket | None

-            # Use match/case here once Python 3.9 becomes unsupported.

+            # TODO(the-13th-letter): Rewrite using structural pattern

+            # matching.

+            # https://the13thletter.info/derivepassphrase/latest/pycompatibility/#after-eol-py3.9

             if conn_hint == 'client':

                 hint = ssh_agent.SSHAgentClient()

             elif conn_hint == 'socket':

@@ -2737,6 +2740,8 @@ Boo.

                 cli._key_to_phrase(loaded_key, error_callback=err)

+# TODO(the-13th-letter): Remove this class in v1.0.

+# https://the13thletter.info/derivepassphrase/latest/upgrade-notes/#upgrading-to-v1.0

 class TestCLITransition:

     def test_100_help_output(self, monkeypatch: pytest.MonkeyPatch) -> None:

         runner = click.testing.CliRunner(mix_stderr=False)

@@ -404,8 +404,9 @@ class TestStoreroom:

         handler: exporter.ExportVaultConfigDataFunction,

     ) -> None:

         runner = click.testing.CliRunner(mix_stderr=False)

-        # Use parenthesized context manager expressions once Python 3.9

-        # becomes unsupported.

+        # TODO(the-13th-letter): Rewrite using parenthesized

+        # with-statements.

+        # https://the13thletter.info/derivepassphrase/latest/pycompatibility/#after-eol-py3.9

         with contextlib.ExitStack() as stack:

             stack.enter_context(

                 tests.isolated_vault_exporter_config(

@@ -590,8 +590,9 @@ class TestAgentInteraction:

     ) -> None:

         del running_ssh_agent

-        # Use parenthesized context manager expressions once Python 3.9

-        # becomes unsupported.

+        # TODO(the-13th-letter): Rewrite using parenthesized

+        # with-statements.

+        # https://the13thletter.info/derivepassphrase/latest/pycompatibility/#after-eol-py3.9

         with contextlib.ExitStack() as stack:

             stack.enter_context(pytest.raises(exc_type, match=exc_pattern))

             client = stack.enter_context(ssh_agent.SSHAgentClient())

@@ -652,8 +653,9 @@ class TestAgentInteraction:

                 assert single_code in response_codes

             return response_data  # pragma: no cover

-        # Use parenthesized context manager expressions once Python 3.9

-        # becomes unsupported.

+        # TODO(the-13th-letter): Rewrite using parenthesized

+        # with-statements.

+        # https://the13thletter.info/derivepassphrase/latest/pycompatibility/#after-eol-py3.9

         with contextlib.ExitStack() as stack:

             monkeypatch2 = stack.enter_context(monkeypatch.context())

             client = stack.enter_context(ssh_agent.SSHAgentClient())