jw.pkg: Fix "make check" static code check fallout

The previous commits have put rules for linting and formatting via
ruff, yapf, mypy and pyright into place. They are checked with the
make check target, and this commit adds the fixes for the target to
succeed.

It does some refactoring where type checking dug up dirty bits, and
also adds lots of churn in the Python code. To a good deal, that's
owed to mere formatting changes. It would have been better to
seperate those from syntax and refactoring fixes into multiple
commits, so that the interesting changes don't drown in the
formatting nose. However, that would have been a lot of additional
work only to be thrown away by later commits, hence this commit has a
big diff in one piece. The size of the diff is regrettable but
hopefully a one-off: What it buys is automatic format checking for CI
and predictble formats for smaller diffs in the future.

Rules that "make check" enforces are, in the following order

   - Syntax checkers:

      - ruff check .
      - mypy .
      - pyright

   - Format check:

     - yapf --diff --recursive .

The refactoring includes:

  - Turn the Result class into a more elaborate object, capable of
    doing more heavy lifting around stderr and stdout decoding,
    summarizing outcome, and matching error strings.

    Aside from fixing broken type checks, this also removes lots of
    boilerplate calling code which is currently used for handling
    possible call outcome scenarios. Trying to access an inexistent,
    decoded string should raise a meaningful exception by itself now,
    which removes lots of code with case distinctions.

  - Fix Cmd type hierarchy:

    - Add the AbstractCmd class above Cmd. This is necessary because
      the checker rightfully complains it can't instantiate a Cmd
      instance where constructor arguments were needed. They never
      were, but the type used at the instantiating code's location in
      jw.pkg.App so claims.

    - Lots of sub- and sub-subcommands are derived from the base
      class of the invoking command. That provides some properties
      shared across the ancestor hierarchy of a command, but is
      semantically unsound. Fix that by introducing jw.pkg.BaseCmd
      class as a place to provide basic helpers shared across all
      commands used in a jw.pkg.App's context, and derive all command
      classes from that afresh. The parent command is still reachable
      via a common parent property.

Formatting changes are conforming to PEP-8, mostly, with minor
tweaks. All in all they include the following changes.

  - Remove # -*- coding: utf-8 -*-

    The line was needed by Python 2 which is not supported anylonger.
    For Python 3, the default encoding is UTF-8, anyway.

  - Allow to run "make py-format" without having it produce any
    changes. It's basically "yapf --in-place --recursive ." with some
    code style settings, see conf/topdir/pyproject.toml. The settings
    may be debatable. I've had custom tweaks in place on that target,
    too, but then again, IDEs would have more hassle to integrate
    that.

  - Introduce a 88 character line length limit

  - One import per line, reshuffle them semantically, see
    [tool.isort] in pyproject.toml.

  - Hide imports needed for type-checking only behind

      if TYPE_CHECKING

  - Spaces around assignments accounts for much churn. Having having
    no spaces in inline parameter list assignments and default
    parameter values would arguably be more compact where it's
    useful. On the other hand, I have not found a code formatter
    which allows spaces around assignments in parameter lists broken
    into one per line and that's often better than a wall of text.

  - Add two spaces before # export, as this seems to be mandated by
    PEP-8

  - Use single quotes by default

Signed-off-by: Jan Lindemann <jan@janware.com>

src/python/jw/pkg/lib/ec/SSHClient.py

@@ -1,16 +1,16 @@
-# -*- coding: utf-8 -*-
-
 from __future__ import annotations
 
-from typing import Any, TYPE_CHECKING
+import abc
+import os
+import pwd
+import sys
 
-import os, abc, sys, pwd
 from enum import Flag, auto
+from typing import TYPE_CHECKING
 
-from ..util import pretty_cmd
-from ..log import *
 from ..base import Result
 from ..ExecContext import ExecContext
+from ..log import DEBUG, ERR, INFO, NOTICE, WARNING, log
 from ..Uri import Uri
 
 if TYPE_CHECKING:
@@ -24,48 +24,50 @@ class SSHClient(ExecContext):
         ModEnv = auto()
         Wd = auto()
 
-    def __init__(self, uri: Uri|str, caps: Caps=Caps(0), *args, **kwargs) -> None:
+    def __init__(self, uri: Uri | str, caps: Caps = Caps(0), *args, **kwargs) -> None:
         uri = Uri.pimp(uri)
         if uri.username is None:
             uri.set_username(pwd.getpwuid(os.getuid()).pw_name)
-        super().__init__(uri=uri, *args, **kwargs)
+        super().__init__(uri = uri, *args, **kwargs)
         self.__caps = caps
 
     @abc.abstractmethod
     async def _run_ssh(
+        self,
         cmd: list[str],
-        wd: str|None,
+        wd: str | None,
         verbose: bool,
-        cmd_input: bytes|None,
-        mod_env: dict[str, str]|None,
+        cmd_input: bytes | None,
+        mod_env: dict[str, str] | None,
         interactive: bool,
-        log_prefix: str
+        log_prefix: str,
     ) -> Result:
         pass
 
     async def _run(
         self,
         cmd: list[str],
-        wd: str|None,
+        wd: str | None,
         verbose: bool,
-        cmd_input: bytes|None,
-        mod_env: dict[str, str]|None,
+        cmd_input: bytes | None,
+        mod_env: dict[str, str] | None,
         interactive: bool,
-        log_prefix: str
+        log_prefix: str,
     ) -> Result:
 
         def __log(prio: int, *args):
             log(prio, log_prefix, *args)
 
-        def __log_block(prio: int, title: str, block: str):
+        def __log_block(prio: int, title: str, block: bytes | str | None):
             if self.__caps & self.Caps.LogOutput:
                 return
             if not block:
                 return
-            encoding = sys.stdout.encoding or 'utf-8'
-            block = block.decode(encoding).strip()
-            if not block:
-                return
+            if isinstance(block, bytes):
+                encoding = sys.stdout.encoding or 'utf-8'
+                block = block.decode(encoding).strip()
+            # Needed to pacify pyright: block can't be anything else at this point
+            assert isinstance(block, str)
             delim = f'---- {title} ----'
             __log(prio, f',{delim}')
             for line in block.splitlines():
@@ -79,44 +81,49 @@ class SSHClient(ExecContext):
             raise NotImplementedError('Interactive SSH is not yet implemented')
 
         if mod_env is not None and not self.__caps & self.Caps.ModEnv:
-            raise NotImplementedError('Passing an environment to SSH commands is not yet implemented')
+            raise NotImplementedError(
+                'Passing an environment to SSH commands is not yet implemented'
+            )
 
         ret = await self._run_ssh(
-            cmd=cmd,
-            wd=wd,
-            verbose=verbose,
-            cmd_input=cmd_input,
-            mod_env=mod_env,
-            interactive=interactive,
-            log_prefix=log_prefix
+            cmd = cmd,
+            wd = wd,
+            verbose = verbose,
+            cmd_input = cmd_input,
+            mod_env = mod_env,
+            interactive = interactive,
+            log_prefix = log_prefix,
         )
 
         if verbose:
-            __log_block(NOTICE, 'stdout', ret.stdout)
-            __log_block(NOTICE, 'stderr', ret.stderr)
+            __log_block(NOTICE, 'stdout', ret.stdout_str_or_none)
+            __log_block(NOTICE, 'stderr', ret.stderr_str_or_none)
             if ret.status != 0:
                 __log(WARNING, f'Exit code {ret.status}')
 
         return ret
 
     @property
-    def hostname(self) -> str|None:
+    def hostname(self) -> str | None:
         return self.uri.hostname
 
     @property
-    def port(self) -> int|None:
+    def port(self) -> int | None:
         return self.uri.port
 
     @property
-    def username(self) -> str|None:
+    def username(self) -> str | None:
         return self.uri.username
 
     @property
-    def password(self) -> str|None:
+    def password(self) -> str | None:
         return self.uri.password
 
-def ssh_client(*args, type: str|list[str]|None=None, **kwargs) -> SSHClient: # export
+def ssh_client(
+    *args, type: str | list[str] | None = None, **kwargs
+) -> SSHClient:  # export
     from importlib import import_module
+
     errors: list[str] = []
     if type is None:
         val = os.getenv('JW_DEFAULT_SSH_CLIENT')
@@ -128,11 +135,12 @@ def ssh_client(*args, type: str|list[str]|None=None, **kwargs) -> SSHClient: # e
         type = [type]
     for name in type:
         try:
-            ret = getattr(import_module(f'jw.pkg.lib.ec.ssh.{name}'), name)(*args, **kwargs)
+            ret = getattr(import_module(f'jw.pkg.lib.ec.ssh.{name}'),
+                          name)(*args, **kwargs)
             log(INFO, f'Using SSH-client "{name}"')
             return ret
         except Exception as e:
-            msg = f'Can\'t instantiate SSH client class {name} ({str(e)})'
+            msg = f"Can't instantiate SSH client class {name} ({str(e)})"
             errors.append(msg)
             log(DEBUG, f'{msg}, trying next')
     msg = f'No working SSH clients for {" ".join([str(arg) for arg in args])}'