py-check.mk: Run isort with "make format"

If /usr/bin/isort is found, run it during "make format" to get a
defined way the imports are sorted. tool.isort in pyproject.toml is
updated to match the other fixers.

Commit the fallout of this change. Running the other fixers alone
doesn't change the formatting, so this should be safe.

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

conf/templates/pyproject.toml

@@ -17,6 +17,9 @@
 
 [tool.isort]
 
+  multi_line_output = 3
+  line_length = 88
+  lines_after_imports = 1
   lines_between_sections = 1
   lines_between_types = 1
 

make/py-check.mk

@@ -29,6 +29,10 @@ ifndef PY_CHECK_RUFF
   endif
 endif
 
+ifndef PY_CHECK_ISORT
+  PY_CHECK_ISORT            := $(firstword $(wildcard /usr/bin/isort))
+endif
+
 ifndef PY_CHECK_YAPF
   PY_CHECK_YAPF             := $(firstword $(wildcard /usr/bin/yapf /usr/bin/yapf3))
 endif
@@ -67,6 +71,9 @@ endif
 py-format:
 	find . -type f -name '*.py' -print0 | \
 		xargs -0 sed -i -E '1{/^# -\*- coding: utf-8 -\*-$$/{:a;N;/\n[[:space:]]*$$/ba;s/^# -\*- coding: utf-8 -\*-\n([[:space:]]*\n)*/ /;s/^ //}}'
+ifneq ($(PY_CHECK_ISORT),)
+	$(PY_CHECK_ISORT) $(PY_CHECK_ROOTS)
+endif
 ifneq ($(PY_CHECK_YAPF),)
 	$(PY_CHECK_YAPF) --in-place --recursive $(PY_CHECK_ROOTS)
 endif

src/python/jw/pkg/App.py

@@ -10,7 +10,7 @@ import sys
 
 from enum import Enum, auto
 from functools import cache
-from typing import Any, cast, override, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, cast, override
 
 from .lib.App import App as Base
 from .lib.Distro import Distro
@@ -19,8 +19,8 @@ from .lib.ProjectConf import ProjectConf
 
 if TYPE_CHECKING:
     import argparse
-    from argparse import ArgumentParser
 
+    from argparse import ArgumentParser
     from typing import TypeAlias
 
     from .lib.ExecContext import ExecContext

src/python/jw/pkg/CmdBase.py

@@ -1,4 +1,5 @@
 from typing import override
+
 from .App import App
 from .lib.Cmd import Cmd as Base
 

src/python/jw/pkg/cmds/Cmd.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import override, TYPE_CHECKING
+from typing import TYPE_CHECKING, override
 
 from ..App import App as Parent
 from ..CmdBase import CmdBase as Base
@@ -8,6 +8,7 @@ from ..CmdBase import CmdBase as Base
 if TYPE_CHECKING:
     from argparse import Namespace
     from typing import Iterable
+
     from ..lib.Distro import Distro
 
 class Cmd(Base):  # export

src/python/jw/pkg/cmds/pkg/CmdInstall.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import override, TYPE_CHECKING
+from typing import TYPE_CHECKING, override
 
 from .Cmd import Cmd, Parent
 

src/python/jw/pkg/cmds/posix/Cmd.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import override, TYPE_CHECKING
+from typing import TYPE_CHECKING, override
 
 from ...CmdBase import CmdBase as Base
 from ..CmdPosix import CmdPosix as Parent

src/python/jw/pkg/cmds/posix/tar/Cmd.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from contextlib import asynccontextmanager
-from typing import Any, override, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, override
 
 from ....CmdBase import CmdBase as Base
 from ....lib.FileContext import FileContext

src/python/jw/pkg/cmds/posix/tar/CmdExtract.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
+from typing import TYPE_CHECKING, override
+
 from ....lib.log import DEBUG, log
 from .Cmd import Cmd, Parent
-from typing import TYPE_CHECKING, override
 
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace

src/python/jw/pkg/cmds/projects/Cmd.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import override, TYPE_CHECKING
+from typing import TYPE_CHECKING, override
 
 from ...CmdBase import CmdBase as Base
 from ..CmdProjects import CmdProjects as Parent

src/python/jw/pkg/cmds/projects/CmdCanonicalizeRemotes.py

@@ -2,10 +2,9 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, override
 
-from ...lib.base import InputMode
+from ...lib.base import InputMode, Result
 from ...lib.log import NOTICE, log
 from .Cmd import Cmd, Parent
-from ...lib.base import Result
 
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace

src/python/jw/pkg/cmds/projects/CmdCflags.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
+from typing import TYPE_CHECKING, override
+
 from ...App import Scope
 from .Cmd import Cmd, Parent
-from typing import TYPE_CHECKING, override
 
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace

src/python/jw/pkg/cmds/projects/CmdCheck.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
-from .Cmd import Cmd, Parent
 from typing import TYPE_CHECKING, override
 
+from .Cmd import Cmd, Parent
+
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace
 

src/python/jw/pkg/cmds/projects/CmdCommands.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
-from .Cmd import Cmd, Parent
 from typing import TYPE_CHECKING, override
 
+from .Cmd import Cmd, Parent
+
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace
 

src/python/jw/pkg/cmds/projects/CmdExepath.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
+from typing import TYPE_CHECKING, override
+
 from ...App import Scope
 from .Cmd import Cmd, Parent
-from typing import TYPE_CHECKING, override
 
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace

src/python/jw/pkg/cmds/projects/CmdGetAuthInfo.py

@@ -1,11 +1,13 @@
 from __future__ import annotations
+
 import os
 import re
 
+from typing import TYPE_CHECKING, override
+
 from ...lib.log import DEBUG, log
 from ...lib.Uri import Uri
 from .Cmd import Cmd, Parent
-from typing import TYPE_CHECKING, override
 
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace

src/python/jw/pkg/cmds/projects/CmdGetval.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
-from .Cmd import Cmd, Parent
 from typing import TYPE_CHECKING, override
 
+from .Cmd import Cmd, Parent
+
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace
 

src/python/jw/pkg/cmds/projects/CmdHtdocsDir.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
-from .Cmd import Cmd, Parent
 from typing import TYPE_CHECKING, override
 
+from .Cmd import Cmd, Parent
+
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace
 

src/python/jw/pkg/cmds/projects/CmdLdflags.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
+from typing import TYPE_CHECKING, override
+
 from ...App import Scope
 from .Cmd import Cmd, Parent
-from typing import TYPE_CHECKING, override
 
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace

src/python/jw/pkg/cmds/projects/CmdLdlibpath.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
+from typing import TYPE_CHECKING, override
+
 from ...App import Scope
 from .Cmd import Cmd, Parent
-from typing import TYPE_CHECKING, override
 
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace

src/python/jw/pkg/cmds/projects/CmdLibname.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
-from .Cmd import Cmd, Parent
 from typing import TYPE_CHECKING, override
 
+from .Cmd import Cmd, Parent
+
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace
 

src/python/jw/pkg/cmds/projects/CmdListRepos.py

@@ -1,12 +1,14 @@
 from __future__ import annotations
+
 import os
 import re
 
+from typing import TYPE_CHECKING, override
+
 from ...lib.log import DEBUG, log
 from ...lib.Uri import Uri
 from ...lib.util import get_password, get_username, run_curl_into
 from .Cmd import Cmd, Parent
-from typing import TYPE_CHECKING, override
 
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace

src/python/jw/pkg/cmds/projects/CmdModules.py

@@ -1,9 +1,11 @@
 from __future__ import annotations
+
 import re
 
+from typing import TYPE_CHECKING, override
+
 from ...lib.log import DEBUG, log
 from .Cmd import Cmd, Parent
-from typing import TYPE_CHECKING, override
 
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace

src/python/jw/pkg/cmds/projects/CmdPath.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
+from typing import TYPE_CHECKING, override
+
 from ...App import Scope
 from .Cmd import Cmd, Parent
-from typing import TYPE_CHECKING, override
 
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace

src/python/jw/pkg/cmds/projects/CmdPkgConflicts.py

@@ -1,4 +1,5 @@
-from .BaseCmdPkgRelations import BaseCmdPkgRelations as Base, Parent
+from .BaseCmdPkgRelations import BaseCmdPkgRelations as Base
+from .BaseCmdPkgRelations import Parent
 
 class CmdPkgConflicts(Base):  # export
 

src/python/jw/pkg/cmds/projects/CmdPkgProvides.py

@@ -1,4 +1,5 @@
-from .BaseCmdPkgRelations import BaseCmdPkgRelations as Base, Parent
+from .BaseCmdPkgRelations import BaseCmdPkgRelations as Base
+from .BaseCmdPkgRelations import Parent
 
 class CmdPkgProvides(Base):  # export
 

src/python/jw/pkg/cmds/projects/CmdPkgRequires.py

@@ -1,4 +1,5 @@
-from .BaseCmdPkgRelations import BaseCmdPkgRelations as Base, Parent
+from .BaseCmdPkgRelations import BaseCmdPkgRelations as Base
+from .BaseCmdPkgRelations import Parent
 
 class CmdPkgRequires(Base):  # export
 

src/python/jw/pkg/cmds/projects/CmdProjDir.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
+from typing import TYPE_CHECKING, override
+
 from ...lib.log import WARNING, log
 from .Cmd import Cmd, Parent
-from typing import TYPE_CHECKING, override
 
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace

src/python/jw/pkg/cmds/projects/CmdRequiredOsPkg.py

@@ -1,9 +1,10 @@
 from __future__ import annotations
 
+from typing import TYPE_CHECKING, override
+
 from ...App import Scope
 from ...lib.log import DEBUG, log
 from .Cmd import Cmd, Parent
-from typing import TYPE_CHECKING, override
 
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace

src/python/jw/pkg/cmds/projects/CmdSummary.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
-from .Cmd import Cmd, Parent
 from typing import TYPE_CHECKING, override
 
+from .Cmd import Cmd, Parent
+
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace
 

src/python/jw/pkg/cmds/projects/CmdTest.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
-from .Cmd import Cmd, Parent
 from typing import TYPE_CHECKING, override
 
+from .Cmd import Cmd, Parent
+
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace
 

src/python/jw/pkg/cmds/projects/CmdTmplDir.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
-from .Cmd import Cmd, Parent
 from typing import TYPE_CHECKING, override
 
+from .Cmd import Cmd, Parent
+
 if TYPE_CHECKING:
     from argparse import ArgumentParser, Namespace
 

src/python/jw/pkg/cmds/projects/check/Cmd.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import override, TYPE_CHECKING
+from typing import TYPE_CHECKING, override
 
 from ....CmdBase import CmdBase as Base
 from ..CmdCheck import CmdCheck as Parent

src/python/jw/pkg/cmds/projects/lib/templates.py

@@ -1,4 +1,5 @@
 import textwrap
+
 from typing import Any, Iterable, TypeAlias, TypeGuard
 
 TupleList: TypeAlias = Iterable[tuple[str, str]]

src/python/jw/pkg/cmds/secrets/Cmd.py

@@ -1,15 +1,15 @@
 from __future__ import annotations
 
 from functools import cached_property
-from typing import override, TYPE_CHECKING
+from typing import TYPE_CHECKING, override
 
 from ...CmdBase import CmdBase as Base
 from ..CmdSecrets import CmdSecrets as Parent
 from .lib.DistroContext import DistroContext
 
 if TYPE_CHECKING:
-    from collections.abc import Collection
     from argparse import ArgumentParser
+    from collections.abc import Collection
 
     from .lib.base import Attrs
 

src/python/jw/pkg/cmds/secrets/lib/DistroContext.py

@@ -12,9 +12,9 @@ from .FilesContext import FilesContext
 
 if TYPE_CHECKING:
     from collections.abc import Collection
-    from .base import Attrs
 
     from ....lib.Distro import Distro
+    from .base import Attrs
 
 class DistroContext(FilesContext):
 

src/python/jw/pkg/cmds/secrets/lib/tar.py

@@ -6,8 +6,8 @@ import tarfile
 from tarfile import TarFile
 from typing import TYPE_CHECKING, Callable
 
-from ....lib.log import DEBUG, log
 from ....lib.ExecContext import ExecContext
+from ....lib.log import DEBUG, log
 
 if TYPE_CHECKING:
     from typing import Iterable

src/python/jw/pkg/lib/App.py

@@ -6,7 +6,7 @@ import os
 import sys
 
 from argparse import ArgumentDefaultsHelpFormatter, ArgumentParser, Namespace
-from typing import Any, cast, override, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, cast, override
 
 from .AsyncRunner import AsyncRunner
 from .log import (
@@ -21,14 +21,14 @@ from .log import (
     set_log_flags,
     set_log_level
 )
-
 from .Types import LoadTypes
 from .util import pretty_cmd
 
 if TYPE_CHECKING:
+    import types
+
     from collections.abc import Awaitable, Collection
     from typing import TypeVar
-
     T = TypeVar('T')
 
 class App:  # export
@@ -119,8 +119,8 @@ class App:  # export
                     self.parser = parser
 
             title = 'Available subcommands'
-            if hasattr(parent, 'name'):
+            if isinstance(parent, AbstractCmd):
-                title += ' of ' + getattr(parent, 'name')
+                title += ' of ' + parent.name
             subparsers = parser.add_subparsers(
                 title = title, metavar = '', dest = 'command'
             )
@@ -139,7 +139,7 @@ class App:  # export
                             sc.cmd, sc.parser, sc.cmd.children, all = all
                         )
                 return
-            args, unknown = self.__parser.parse_known_args()
+            args, _ = self.__parser.parse_known_args()
             cmd_name = getattr(args, 'command', None)
             if cmd_name in scs:
                 sc = scs[cmd_name]
@@ -185,7 +185,7 @@ class App:  # export
         )
         self._add_arguments(self.__parser)
 
-        args, unknown = self.__parser.parse_known_args()
+        args, _ = self.__parser.parse_known_args()
         set_log_flags(args.log_flags)
         set_log_level(args.log_level)
 
@@ -222,7 +222,12 @@ class App:  # export
     async def __aenter__(self) -> None:
         pass
 
-    async def __aexit__(self, exc_type: Any, exc: Any, tb: Any) -> None:
+    async def __aexit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc: BaseException | None,
+        tb: types.TracebackType | None,
+    ) -> None:
         pass
 
     async def __run(self, argv: list[str] | None = None) -> None:
@@ -230,16 +235,13 @@ class App:  # export
         try:
             # Import argcomplete only here to not require it to be compatible
             # with minimal environments
-            from argcomplete.completers import ( # type: ignore[import-not-found, unused-ignore]
+            from argcomplete.completers import BaseCompleter  # type: ignore[import-not-found, unused-ignore] # isort: skip
-                BaseCompleter
-            )
 
             class NoopCompleter(BaseCompleter):  # type: ignore[misc, unused-ignore]
 
                 @override
                 def __call__(  # pyright: ignore[reportGeneralTypeIssues]
-                    self, *args: Any, **kwargs: Any
+                        self, *args: Any, **kwargs: Any) -> None:
-                ) -> None:
                     return None
 
             import argcomplete  # type: ignore[import-not-found, unused-ignore]
@@ -266,7 +268,7 @@ class App:  # export
             if isinstance(ret, int) and ret >= 0 and ret <= 0xFF:
                 exit_status = ret
         except Exception as e:
-            log_m(ERR, 'Failed: {}'.format(repr(e) if self.__back_trace else str(e)))
+            log_m(ERR, f'Failed: {repr(e) if self.__back_trace else str(e)}')
             exit_status = 1
             # AssertionErrors are programming errors, hence a programmer should
             # get a chance to figure it out
@@ -339,6 +341,7 @@ class App:  # export
                 self.__async_runner = None
         return ret
 
+
 def run_sub_commands(  # export
     description: str = '',
     name_filter: str = '^Cmd.*',

src/python/jw/pkg/lib/AsyncRunner.py

@@ -4,7 +4,7 @@ import asyncio
 import concurrent.futures
 import contextlib
 
-from typing import Any, TypeVar, TYPE_CHECKING, cast
+from typing import TYPE_CHECKING, Any, TypeVar, cast
 
 if TYPE_CHECKING:
     from collections.abc import Awaitable, Generator

src/python/jw/pkg/lib/Distro.py

@@ -8,8 +8,8 @@ import sys
 from functools import cached_property
 from typing import TYPE_CHECKING, Any
 
-from .log import ERR, INFO, WARNING, log
 from .base import InputMode
+from .log import ERR, INFO, WARNING, log
 
 if TYPE_CHECKING:
     from collections.abc import Collection

src/python/jw/pkg/lib/ExecContext.py

@@ -5,7 +5,7 @@ import errno
 import sys
 
 from decimal import ROUND_FLOOR, Decimal
-from typing import Any, override, TYPE_CHECKING, NamedTuple
+from typing import TYPE_CHECKING, Any, NamedTuple, override
 
 if TYPE_CHECKING:
     from typing import Type

src/python/jw/pkg/lib/FileContext.py

@@ -4,11 +4,11 @@ import abc
 
 from enum import Enum, auto
 from functools import cached_property
-from typing import Any, override, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, override
 
 from .log import DEBUG, ERR, log
-from .Uri import Uri
 from .ProcFilter import ProcPipeline
+from .Uri import Uri
 
 if TYPE_CHECKING:
     from .base import Result, StatResult

src/python/jw/pkg/lib/Package.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import override, Any
+from typing import Any, override
 
 meta_tags = [
     'name',

src/python/jw/pkg/lib/PackageFilter.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
+
 import abc
 import re
 

src/python/jw/pkg/lib/TarIo.py

@@ -5,11 +5,11 @@ import io
 import tarfile
 
 from tarfile import TarFile, TarInfo
+from typing import TYPE_CHECKING, Any, override
 
 from .CopyContext import CopyContext
 from .ExecContext import ExecContext
 from .log import DEBUG, ERR, log
-from typing import TYPE_CHECKING, Any, override
 
 if TYPE_CHECKING:
     from .base import StatResult

src/python/jw/pkg/lib/Types.py

@@ -5,7 +5,7 @@ import os
 import re
 import sys
 
-from typing import Any, override, TYPE_CHECKING, Generic, Iterable, TypeVar
+from typing import TYPE_CHECKING, Any, Generic, Iterable, TypeVar, override
 
 from .log import ERR, OFF, log, parse_log_level
 

src/python/jw/pkg/lib/Uri.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import copy
 
 from functools import cached_property
-from typing import override, TYPE_CHECKING
+from typing import TYPE_CHECKING, override
 
 if TYPE_CHECKING:
     import urllib.parse

src/python/jw/pkg/lib/distros/arch/Distro.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any, override, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, override
 
 from ...Distro import Distro as Base
 

src/python/jw/pkg/lib/distros/debian/Distro.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import os
 
-from typing import Any, override, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, override
 
 from ...Distro import Distro as Base
 from ...log import NOTICE, log

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

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any, override, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, override
 
 from ..FileContext import FileContext as Base
 

src/python/jw/pkg/lib/ec/ssh/Exec.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import os
 
-from typing import Any, override, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, override
 
 from ...base import InputMode
 from ...util import run_cmd

src/python/jw/pkg/lib/ec/ssh/Paramiko.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any, override, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, override
 
 # Tolerate missing paramiko imports. jw-pkg is designed to work with what it
 # finds.

src/python/jw/pkg/lib/init.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import pkgutil
+
 from importlib import import_module
 from typing import TYPE_CHECKING
 

src/python/jw/pkg/lib/log.py

@@ -5,9 +5,8 @@ import re
 import sys
 import syslog
 
-from enum import Flag, auto
-
 from datetime import datetime
+from enum import Flag, auto
 from os.path import basename
 from typing import TYPE_CHECKING, cast, override
 

src/python/jw/pkg/lib/pm/rpm.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any, TYPE_CHECKING, Collection, Iterable, cast
+from typing import TYPE_CHECKING, Any, Collection, Iterable, cast
 
 from ..base import InputMode
 from ..Package import Package

src/python/jw/pkg/lib/util.py

@@ -13,6 +13,7 @@ from .Uri import Uri
 
 if TYPE_CHECKING:
     from argparse import Namespace
+
     from .ExecContext import ExecContext
     from .FileContext import FileContext
     from .ProcFilter import ProcFilter, ProcPipeline