derivepassphrase.git

@@ -495,7 +495,8 @@ The <b>derivepassphrase vault</b> utility exits 0 on success, and >0 if an error

     The <i>vault</i>(1) legacy editor interface is in use, which carries a high risk of accidentally losing or corrupting the old notes because a notes editing session cannot be aborted mid-editing.

     To guard against such accidental data loss, a backup copy of the old notes was saved to the <b>derivepassphrase</b> configuration directory.

-<!-- Message-ID: WarnMsgTemplate.NO_AF_UNIX -->

+<!-- Message-ID: WarnMsgTemplate.NO_UNIX_DOMAIN_SOCKETS -->

+<!-- Message-ID (mark only): WarnMsgTemplate.NO_AF_UNIX -->

 ??? warning "`Cannot connect to an SSH agent via UNIX domain sockets because this Python version does not support them.`"

     [Since v0.6.]

@@ -503,7 +504,8 @@ The <b>derivepassphrase vault</b> utility exits 0 on success, and >0 if an error

     (Only appears together with the error message "Cannot connect to an SSH agent because this Python version does not support communicating with it.".

     Other, similar messages about unsupported communication mechanisms may precede the error message.)

-<!-- Message-ID: WarnMsgTemplate.NO_ANNOYING_OS_NAMED_PIPES -->

+<!-- Message-ID: WarnMsgTemplate.NO_WINDOWS_NAMED_PIPES -->

+<!-- Message-ID (mark only): WarnMsgTemplate.NO_ANNOYING_OS_NAMED_PIPES -->

 ??? warning "`Cannot connect to an SSH agent via Windows named pipes because this Python version does not support them.`"

     [Since v0.6.]

@@ -1025,8 +1025,8 @@ notes was saved to the

 .Nm derivepassphrase

 configuration directory.

 .

-.\" Message-ID: WarnMsgTemplate.NO_AF_UNIX

-.\" Message-ID (mark only): ErrMsgTemplate.NO_AF_UNIX

+.\" Message-ID: WarnMsgTemplate.NO_UNIX_DOMAIN_SOCKETS

+.\" Message-ID (mark only): WarnMsgTemplate.NO_AF_UNIX

 .It Cannot connect to an SSH agent via UNIX domain sockets because this Python version does not support them.

 We attempted to use

 .Tn UNIX

@@ -1042,7 +1042,8 @@ Other, similar messages about unsupported communication mechanisms may

 precede the error message.

 .Pc

 .

-.\" Message-ID: WarnMsgTemplate.NO_ANNOYING_OS_NAMED_PIPES

+.\" Message-ID: WarnMsgTemplate.NO_WINDOWS_NAMED_PIPES

+.\" Message-ID (mark only): WarnMsgTemplate.NO_ANNOYING_OS_NAMED_PIPES

 .It Cannot connect to an SSH agent via Windows named pipes because this Python version does not support them.

 We attempted to use

 .Tn Windows

@@ -741,16 +741,20 @@ def handle_notimplementederror(

     """  # noqa: DOC201

     def handle_notimplementederror(excgroup: BaseExceptionGroup) -> NoReturn:

-        if excgroup.subgroup(socketprovider.AfUnixNotAvailableError):

+        if excgroup.subgroup(

+            socketprovider.UnixDomainSocketsNotAvailableError

+        ):

             warning_callback(

-                _msg.TranslatedString(_msg.WarnMsgTemplate.NO_AF_UNIX)

+                _msg.TranslatedString(

+                    _msg.WarnMsgTemplate.NO_UNIX_DOMAIN_SOCKETS

+                )

             )

         if excgroup.subgroup(

-            socketprovider.TheAnnoyingOsNamedPipesNotAvailableError

+            socketprovider.WindowsNamedPipesNotAvailableError

         ):

             warning_callback(

                 _msg.TranslatedString(

-                    _msg.WarnMsgTemplate.NO_ANNOYING_OS_NAMED_PIPES

+                    _msg.WarnMsgTemplate.NO_WINDOWS_NAMED_PIPES

                 )

             )

         error_callback(

@@ -1953,7 +1953,7 @@ class WarnMsgTemplate(enum.Enum):

         "aborting mid-edit, and because the notes were actually changed.",

         flags="python-brace-format",

     )

-    NO_AF_UNIX = commented(

+    NO_UNIX_DOMAIN_SOCKETS = commented(

         "",

     )(

         "Warning message",

@@ -1961,7 +1961,7 @@ class WarnMsgTemplate(enum.Enum):

         "because this Python version does not support them.",

     )

     """"""

-    NO_ANNOYING_OS_NAMED_PIPES = commented(

+    NO_WINDOWS_NAMED_PIPES = commented(

         "",

     )(

         "Warning message",

@@ -24,11 +24,17 @@ class NoSuchProviderError(KeyError):

     """No such SSH agent socket provider is known."""

-class AfUnixNotAvailableError(NotImplementedError):

-    """This Python installation does not support socket.AF_UNIX."""

+class UnixDomainSocketsNotAvailableError(NotImplementedError):

+    """This Python installation does not support UNIX domain sockets.

+    On this installation, the standard library symbol

+    [`socket.AF_UNIX`][] is not available, necessary to create UNIX

+    domain sockets.

-class TheAnnoyingOsNamedPipesNotAvailableError(NotImplementedError):

+    """

+

+

+class WindowsNamedPipesNotAvailableError(NotImplementedError):

     """This Python installation does not support Windows named pipes."""

@@ -52,13 +58,11 @@ class SocketProvider:

         Raises:

             KeyError:

                 The `SSH_AUTH_SOCK` environment variable was not found.

-            AfUnixNotAvailableError:

-                [This Python version does not support UNIX domain

-                sockets][AF_UNIX], necessary to automatically connect to

+            UnixDomainSocketsNotAvailableError:

+                This Python version does not support UNIX domain

+                sockets, necessary to automatically connect to

                 a running SSH agent via the `SSH_AUTH_SOCK` environment

                 variable.

-

-                [AF_UNIX]: https://docs.python.org/3/library/socket.html#socket.AF_UNIX

             OSError:

                 There was an error setting up a socket connection to the

                 agent.

@@ -66,7 +70,7 @@ class SocketProvider:

         """

         if not hasattr(socket, "AF_UNIX"):

             msg = "This Python version does not support UNIX domain sockets."

-            raise AfUnixNotAvailableError(msg)

+            raise UnixDomainSocketsNotAvailableError(msg)

         else:  # noqa: RET506  # pragma: unless posix no cover

             sock = socket.socket(family=socket.AF_UNIX)

             if "SSH_AUTH_SOCK" not in os.environ:

@@ -78,7 +82,7 @@ class SocketProvider:

             return sock

     @staticmethod

-    def the_annoying_os_named_pipes() -> _types.SSHAgentSocket:

+    def windows_named_pipe() -> _types.SSHAgentSocket:

         """Return a socket connected to Pageant/OpenSSH on The Annoying OS.

         This may be a write-through socket if the underlying connection

@@ -86,7 +90,7 @@ class SocketProvider:

         communicate.

         Raises:

-            TheAnnoyingOsNamedPipesNotAvailableError:

+            WindowsNamedPipesNotAvailableError:

                 This functionality is not implemented yet.

         Warning: Not implemented yet

@@ -100,7 +104,7 @@ class SocketProvider:

         """

         if not hasattr(ctypes, "WinDLL"):

             msg = "This Python version does not support Windows named pipes."

-            raise TheAnnoyingOsNamedPipesNotAvailableError(msg)

+            raise WindowsNamedPipesNotAvailableError(msg)

         else:  # noqa: RET506  # pragma: unless the-annoying-os no cover

             msg = (

                 "Communicating with Pageant or OpenSSH on Windows "

@@ -338,7 +342,7 @@ class SocketProvider:

 SocketProvider.registry.update({

     "posix": SocketProvider.unix_domain_ssh_auth_sock,

-    "the_annoying_os": SocketProvider.the_annoying_os_named_pipes,

+    "the_annoying_os": SocketProvider.windows_named_pipe,

     # known instances

     "stub_agent": None,

     "stub_with_address": None,

@@ -356,8 +356,8 @@ the_annoying_os_entry = _types.SSHAgentSocketProviderEntry(

     (),

 )

 """

-The standard [`_types.SSHAgentSocketProviderEntry`][] for the named pipe

-handler on The Annoying Operating System.

+The standard [`_types.SSHAgentSocketProviderEntry`][] for the Windows

+named pipe handler on The Annoying Operating System.

 """

 faulty_entry_callable = _types.SSHAgentSocketProviderEntry(

@@ -199,24 +199,24 @@ class SocketAddressAction(str, enum.Enum):

     """Test fixture settings for the SSH agent socket address.

     Attributes:

-        MANGLE_ANNOYING_OS_NAMED_PIPE:

-            Mangle the address for the Annoying OS named pipe endpoint.

+        MANGLE_WINDOWS_NAMED_PIPE:

+            Mangle the address for the Windows named pipe endpoint.

         MANGLE_SSH_AUTH_SOCK:

             Mangle the address for the UNIX domain socket (the

             `SSH_AUTH_SOCK` environment variable).

-        UNSET_ANNOYING_OS_NAMED_PIPE:

-            Unset the address for the Annoying OS named pipe endpoint.

+        UNSET_WINDOWS_NAMED_PIPE:

+            Unset the address for the Windows named pipe endpoint.

         UNSET_SSH_AUTH_SOCK:

             Unset the `SSH_AUTH_SOCK` environment variable (the address

             for the UNIX domain socket).

     """

-    MANGLE_ANNOYING_OS_NAMED_PIPE = enum.auto()

+    MANGLE_WINDOWS_NAMED_PIPE = enum.auto()

     """"""

     MANGLE_SSH_AUTH_SOCK = enum.auto()

     """"""

-    UNSET_ANNOYING_OS_NAMED_PIPE = enum.auto()

+    UNSET_WINDOWS_NAMED_PIPE = enum.auto()

     """"""

     UNSET_SSH_AUTH_SOCK = enum.auto()

     """"""

@@ -229,8 +229,8 @@ class SocketAddressAction(str, enum.Enum):

         # matching.

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

         if self in {

-            self.MANGLE_ANNOYING_OS_NAMED_PIPE,

-            self.UNSET_ANNOYING_OS_NAMED_PIPE,

+            self.MANGLE_WINDOWS_NAMED_PIPE,

+            self.UNSET_WINDOWS_NAMED_PIPE,

         }:  # pragma: no cover [unused]

             pass

         elif self == self.MANGLE_SSH_AUTH_SOCK:

@@ -260,10 +260,10 @@ class SystemSupportAction(str, enum.Enum):

         UNSET_PROVIDER_LIST:

             Ensure an empty list of SSH agent socket providers.

         UNSET_WINDLL:

-            Ensure lack of support for The Annoying OS named pipes.

+            Ensure lack of support for Windows named pipes.

         UNSET_WINDLL_AND_ENSURE_USE:

-            Ensure lack of support for The Annoying OS named pipes, and

-            that the agent will use this socket provider.

+            Ensure lack of support for Windows named pipes, and that the

+            agent will use this socket provider.

     """