derivepassphrase.git

@@ -1308,6 +1308,9 @@ class ZshComplete(click.shell_completion.ZshComplete):

     adaptively and "smartly" emit colon-escaped output or not, based on

     whether the completion script will be using it.

+    As of `click` v8.2.2, the Zsh completion class also adaptively emits

+    colon-escaped output or not, based on the very same criterion.

+

     """

     @override

@@ -21,7 +21,7 @@ from __future__ import annotations

 import base64

 import enum

-from typing import TYPE_CHECKING, Protocol

+from typing import TYPE_CHECKING, Protocol, cast

 from typing_extensions import NamedTuple

@@ -1356,7 +1356,7 @@ DUMMY_KEY3 = SUPPORTED_KEYS["ed448"].public_key_data

 """A third supported SSH test key (in wire format)."""

 DUMMY_KEY3_B64 = base64.standard_b64encode(DUMMY_KEY3).decode("ASCII")

 """A third supported SSH test key (in `authorized_keys` format)."""

-DUMMY_CONFIG_SETTINGS = {

+DUMMY_CONFIG_SETTINGS = cast("_types.VaultConfigServicesSettings", {

     "length": 10,

     "upper": 1,

     "lower": 1,

@@ -1365,7 +1365,7 @@ DUMMY_CONFIG_SETTINGS = {

     "space": 1,

     "dash": 1,

     "symbol": 1,

-}

+})

 """Sample vault settings."""

 DUMMY_RESULT_PASSPHRASE = b".2V_QJkd o"

 """

@@ -44,17 +44,9 @@ DUMMY_PASSPHRASE = data.DUMMY_PASSPHRASE

 DUMMY_CONFIG_SETTINGS = data.DUMMY_CONFIG_SETTINGS

 DUMMY_RESULT_PASSPHRASE = data.DUMMY_RESULT_PASSPHRASE

 DUMMY_RESULT_KEY1 = data.DUMMY_RESULT_KEY1

-DUMMY_PHRASE_FROM_KEY1_RAW = data.DUMMY_PHRASE_FROM_KEY1_RAW

-DUMMY_PHRASE_FROM_KEY1 = data.DUMMY_PHRASE_FROM_KEY1

-DUMMY_KEY1 = data.DUMMY_KEY1

 DUMMY_KEY1_B64 = data.DUMMY_KEY1_B64

-DUMMY_KEY2 = data.DUMMY_KEY2

 DUMMY_KEY2_B64 = data.DUMMY_KEY2_B64

-DUMMY_KEY3 = data.DUMMY_KEY3

-DUMMY_KEY3_B64 = data.DUMMY_KEY3_B64

-

-TEST_CONFIGS = data.TEST_CONFIGS

 class IncompatibleConfiguration(NamedTuple):

@@ -461,7 +453,7 @@ class Parametrize(types.SimpleNamespace):

     )

     VALID_TEST_CONFIGS = pytest.mark.parametrize(

         "config",

-        [conf.config for conf in TEST_CONFIGS if conf.is_valid()],

+        [conf.config for conf in data.TEST_CONFIGS if conf.is_valid()],

     )

     KEY_OVERRIDING_IN_CONFIG = pytest.mark.parametrize(

         ["config", "command_line"],

@@ -2504,12 +2496,12 @@ class TestStoringConfigurationSuccesses:

     ) -> None:

         """Running without an existing config directory works.

-        This is a regression test; see [issue\u00a0#6][] for context.

-        See also

-        [TestStoringConfigurationFailures001.test_config_directory_not_a_file][]

+        This is a regression test; see [the "pretty-print-json"

+        issue][PRETTY_PRINT_JSON] for context.  See also

+        [TestStoringConfigurationFailures.test_config_directory_not_a_file][]

         for a related aspect of this.

-        [issue #6]: https://github.com/the-13th-letter/derivepassphrase/issues/6

+        [PRETTY_PRINT_JSON]: https://the13thletter.info/derivepassphrase/0.x/wishlist/pretty-print-json/

         """

         runner = machinery.CliRunner(mix_stderr=False)

@@ -2895,12 +2887,12 @@ class TestStoringConfigurationFailures:

         That is, the missing configuration directory does not cause any

         errors by itself.

-        This is a regression test; see [issue\u00a0#6][] for context.

-        See also

-        [TestStoringConfigurationSuccesses001.test_config_directory_nonexistant][]

+        This is a regression test; see [the "pretty-print-json"

+        issue][PRETTY_PRINT_JSON] for context.  See also

+        [TestStoringConfigurationSuccesses.test_config_directory_nonexistant][]

         for a related aspect of this.

-        [issue #6]: https://github.com/the-13th-letter/derivepassphrase/issues/6

+        [PRETTY_PRINT_JSON]: https://the13thletter.info/derivepassphrase/0.x/wishlist/pretty-print-json/

         """

         runner = machinery.CliRunner(mix_stderr=False)

@@ -547,7 +547,9 @@ class TestHelpOutput:

         (The answer currently is always no. See the

         [`conventional-configurable-text-styling` wishlist

-        entry](../wishlist/conventional-configurable-text-styling.md).)

+        entry][WISHLIST_ENTRY].)

+

+        [WISHLIST_ENTRY]: https://the13thletter.info/derivepassphrase/0.x/wishlist/conventional-configurable-text-styling/

         """

         color = False

@@ -60,15 +60,11 @@ def zsh_format(item: click.shell_completion.CompletionItem) -> str:

     r"""A formatter for `zsh`-style shell completion items.

     The format is `type<newline>value<newline>help<newline>`, and is

-    dictated by [`click`][].  Upstream `click` currently (v8.2.0) does

-    not deal with colons in the value correctly when the help text is

-    non-degenerate.  Our formatter here does, provided the upstream

-    `zsh` completion script is used; see the

-    [`cli_machinery.ZshComplete`][] class.  A request is underway to

-    merge this change into upstream `click`; see

-    [`pallets/click#2846`][PR2846].

-

-    [PR2846]: https://github.com/pallets/click/pull/2846

+    dictated by [`click`][].  Upstream `click` up to and including

+    v8.2.1 does not deal with colons in the value correctly when the

+    help text is non-degenerate.  Our formatter here does, provided the

+    upstream `zsh` completion script is used; see the

+    [`cli_machinery.ZshComplete`][] class.

     """

     empty_help = "_"