pyproject.toml: Enforce import annotations style

Add new ruff rules and fix their fallout:

  future-annotations = true

   select = [
    "TC",  # type-checking import placement rules
    "FA",  # future annotations rules
   ]

This comprises:

  - Streamline imports and exports in cmds.xxx.Cmd

    - Import base class as "Base"

    - Export types Cmd and Parent via __all__

  - Move all types imported only for annotation below TYPE_CHECKING

  - Use "from __future__ import annotations" all over the place

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

conf/topdir/pyproject.toml

@@ -38,10 +38,14 @@
 
 [tool.ruff.lint]
 
+  future-annotations = true
+
   select = [
     "F",    # Pyflakes, includes F401
     "E",    # pycodestyle errors
     "W",    # pycodestyle warnings
+    "TC",  # type-checking import placement rules
+    "FA",  # future annotations rules
   ]
 
   ignore = [

src/python/jw/pkg/App.py

@@ -4,7 +4,6 @@
 
 from __future__ import annotations
 
-import argparse
 import os
 import pwd
 import re
@@ -19,10 +18,7 @@ from .lib.Distro import Distro
 from .lib.log import DEBUG, ERR, log
 
 if TYPE_CHECKING:
-    import os
+    import argparse
-    import pwd
-    import re
-    import sys
 
     from typing import TypeAlias
 

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

@@ -2,15 +2,15 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
-from ..CmdBase import CmdBase
+from ..App import App as Parent
+from ..CmdBase import CmdBase as Base
 
 if TYPE_CHECKING:
-    from ..App import App
     from ..lib.Distro import Distro
 
-class Cmd(CmdBase):  # export
+class Cmd(Base):  # export
 
-    def __init__(self, parent: App | CmdBase, name: str, help: str) -> None:
+    def __init__(self, parent: Parent, name: str, help: str) -> None:
         super().__init__(parent, name, help)
 
     async def _run(self, args):
@@ -20,3 +20,5 @@ class Cmd(CmdBase):  # export
     @property
     def distro(self) -> Distro:
         return self.app.distro
+
+__all__ = ['Parent', 'Cmd']

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

@@ -1,11 +1,15 @@
-from argparse import ArgumentParser
+from __future__ import annotations
 
-from ..App import App
+from typing import TYPE_CHECKING
-from .Cmd import Cmd as CmdBase
 
-class CmdPkg(CmdBase):  # export
+from .Cmd import Cmd, Parent
 
-    def __init__(self, parent: App) -> None:
+if TYPE_CHECKING:
+    from argparse import ArgumentParser
+
+class CmdPkg(Cmd):  # export
+
+    def __init__(self, parent: Parent) -> None:
         super().__init__(parent, 'pkg', help = 'System package manager wrapper')
         self.load_subcommands()
 

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

@@ -1,11 +1,15 @@
-from argparse import ArgumentParser
+from __future__ import annotations
 
-from ..App import App
+from typing import TYPE_CHECKING
-from .Cmd import Cmd as CmdBase
 
-class CmdPlatform(CmdBase):  # export
+from .Cmd import Cmd, Parent
 
-    def __init__(self, parent: App) -> None:
+if TYPE_CHECKING:
+    from argparse import ArgumentParser
+
+class CmdPlatform(Cmd):  # export
+
+    def __init__(self, parent: Parent) -> None:
         super().__init__(
             parent, 'platform', help = 'Miscellaneous platform-related comamnds'
         )

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

@@ -1,11 +1,15 @@
-from argparse import ArgumentParser
+from __future__ import annotations
 
-from ..App import App
+from typing import TYPE_CHECKING
-from .Cmd import Cmd as CmdBase
 
-class CmdPosix(CmdBase):  # export
+from .Cmd import Cmd, Parent
 
-    def __init__(self, parent: App) -> None:
+if TYPE_CHECKING:
+    from argparse import ArgumentParser
+
+class CmdPosix(Cmd):  # export
+
+    def __init__(self, parent: Parent) -> None:
         super().__init__(
             parent,
             'posix',

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

@@ -1,13 +1,17 @@
+from __future__ import annotations
+
 import sys
 
-from argparse import ArgumentParser
+from typing import TYPE_CHECKING
 
-from ..App import App
+from .Cmd import Cmd, Parent
-from .Cmd import Cmd as CmdBase
 
-class CmdProjects(CmdBase):  # export
+if TYPE_CHECKING:
+    from argparse import ArgumentParser
 
-    def __init__(self, parent: App) -> None:
+class CmdProjects(Cmd):  # export
+
+    def __init__(self, parent: Parent) -> None:
         super().__init__(
             parent,
             'projects',

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

@@ -1,11 +1,15 @@
-from argparse import ArgumentParser
+from __future__ import annotations
 
-from ..App import App
+from typing import TYPE_CHECKING
-from .Cmd import Cmd as CmdBase
 
-class CmdSecrets(CmdBase):  # export
+from .Cmd import Cmd, Parent
 
-    def __init__(self, parent: App) -> None:
+if TYPE_CHECKING:
+    from argparse import ArgumentParser
+
+class CmdSecrets(Cmd):  # export
+
+    def __init__(self, parent: Parent) -> None:
         super().__init__(parent, 'secrets', help = 'Manage package secrets')
         self.load_subcommands()
 

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

@@ -2,12 +2,19 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
-if TYPE_CHECKING:
+from ...CmdBase import CmdBase as Base
-    from ..CmdPkg import CmdPkg
+from ..CmdPkg import CmdPkg as Parent
 
-from ..Cmd import Cmd as Base
+if TYPE_CHECKING:
+    from ...lib.Distro import Distro
 
 class Cmd(Base):  # export
 
-    def __init__(self, parent: CmdPkg, name: str, help: str) -> None:
+    def __init__(self, parent: Parent, name: str, help: str) -> None:
         super().__init__(parent, name, help)
+
+    @property
+    def distro(self) -> Distro:
+        return self.app.distro
+
+__all__ = ['Parent', 'Cmd']

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

@@ -1,11 +1,15 @@
-from argparse import ArgumentParser, Namespace
+from __future__ import annotations
 
-from ..CmdPkg import CmdPkg
+from typing import TYPE_CHECKING
-from .Cmd import Cmd
+
+from .Cmd import Cmd, Parent
+
+if TYPE_CHECKING:
+    from argparse import ArgumentParser, Namespace
 
 class CmdDelete(Cmd):  # export
 
-    def __init__(self, parent: CmdPkg) -> None:
+    def __init__(self, parent: Parent) -> None:
         super().__init__(parent, 'delete', help = 'Delete packages by name')
 
     def add_arguments(self, parser: ArgumentParser) -> None:

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

@@ -1,11 +1,15 @@
-from argparse import ArgumentParser, Namespace
+from __future__ import annotations
 
-from ..CmdPkg import CmdPkg
+from typing import TYPE_CHECKING
-from .Cmd import Cmd
+
+from .Cmd import Cmd, Parent
+
+if TYPE_CHECKING:
+    from argparse import ArgumentParser, Namespace
 
 class CmdDup(Cmd):  # export
 
-    def __init__(self, parent: CmdPkg) -> None:
+    def __init__(self, parent: Parent) -> None:
         super().__init__(parent, 'dup', help = 'Upgrade distribution')
 
     def add_arguments(self, parser: ArgumentParser) -> None:

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

@@ -1,11 +1,15 @@
-from argparse import ArgumentParser, Namespace
+from __future__ import annotations
 
-from ..CmdPkg import CmdPkg
+from typing import TYPE_CHECKING
-from .Cmd import Cmd
+
+from .Cmd import Cmd, Parent
+
+if TYPE_CHECKING:
+    from argparse import ArgumentParser, Namespace
 
 class CmdInstall(Cmd):  # export
 
-    def __init__(self, parent: CmdPkg) -> None:
+    def __init__(self, parent: Parent) -> None:
         super().__init__(
             parent,
             'install',

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

@@ -1,11 +1,15 @@
-from argparse import ArgumentParser, Namespace
+from __future__ import annotations
 
-from ..CmdPkg import CmdPkg
+from typing import TYPE_CHECKING
-from .NamedPkgsCmd import NamedPkgsCmd as Base
 
-class CmdLs(Base):  # export
+from .Cmd import Cmd, Parent
 
-    def __init__(self, parent: CmdPkg) -> None:
+if TYPE_CHECKING:
+    from argparse import ArgumentParser, Namespace
+
+class CmdLs(Cmd):  # export
+
+    def __init__(self, parent: Parent) -> None:
         super().__init__(parent, 'ls', help = 'List package contents')
 
     def add_arguments(self, parser: ArgumentParser) -> None:

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

@@ -1,11 +1,15 @@
-from argparse import ArgumentParser, Namespace
+from __future__ import annotations
 
-from ..CmdPkg import CmdPkg
+from typing import TYPE_CHECKING
-from .NamedPkgsCmd import NamedPkgsCmd as Base
 
-class CmdMeta(Base):  # export
+from .NamedPkgsCmd import NamedPkgsCmd, Parent
 
-    def __init__(self, parent: CmdPkg) -> None:
+if TYPE_CHECKING:
+    from argparse import ArgumentParser, Namespace
+
+class CmdMeta(NamedPkgsCmd):  # export
+
+    def __init__(self, parent: Parent) -> None:
         super().__init__(parent, 'meta', help = 'List package metadata')
 
     def add_arguments(self, parser: ArgumentParser) -> None:

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

@@ -1,11 +1,15 @@
-from argparse import ArgumentParser, Namespace
+from __future__ import annotations
 
-from ..CmdPkg import CmdPkg
+from typing import TYPE_CHECKING
-from .Cmd import Cmd
+
+from .Cmd import Cmd, Parent
+
+if TYPE_CHECKING:
+    from argparse import ArgumentParser, Namespace
 
 class CmdRebootRequired(Cmd):  # export
 
-    def __init__(self, parent: CmdPkg) -> None:
+    def __init__(self, parent: Parent) -> None:
         super().__init__(
             parent,
             'reboot-required',

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

@@ -1,11 +1,15 @@
-from argparse import ArgumentParser, Namespace
+from __future__ import annotations
 
-from ..CmdPkg import CmdPkg
+from typing import TYPE_CHECKING
-from .Cmd import Cmd
+
+from .Cmd import Cmd, Parent
+
+if TYPE_CHECKING:
+    from argparse import ArgumentParser, Namespace
 
 class CmdRefresh(Cmd):  # export
 
-    def __init__(self, parent: CmdPkg) -> None:
+    def __init__(self, parent: Parent) -> None:
         super().__init__(
             parent,
             'refresh',

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

@@ -1,12 +1,16 @@
-from argparse import ArgumentParser, Namespace
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
 
 from ...lib.PackageFilter import PackageFilterString
-from ..CmdPkg import CmdPkg
+from .Cmd import Cmd, Parent
-from .Cmd import Cmd
+
+if TYPE_CHECKING:
+    from argparse import ArgumentParser, Namespace
 
 class CmdSelect(Cmd):  # export
 
-    def __init__(self, parent: CmdPkg) -> None:
+    def __init__(self, parent: Parent) -> None:
         super().__init__(parent, 'select', help = 'Select packages by filter')
 
     def add_arguments(self, parser: ArgumentParser) -> None:

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

@@ -1,9 +1,13 @@
-from argparse import ArgumentParser
+from __future__ import annotations
 
-from ..CmdPkg import CmdPkg as Parent
+from typing import TYPE_CHECKING
-from .Cmd import Cmd as Base
 
-class NamedPkgsCmd(Base):  # export
+from .Cmd import Cmd, Parent
+
+if TYPE_CHECKING:
+    from argparse import ArgumentParser
+
+class NamedPkgsCmd(Cmd):  # export
 
     def __init__(self, parent: Parent, name: str, help: str) -> None:
         super().__init__(parent, name, help)
@@ -11,3 +15,5 @@ class NamedPkgsCmd(Base):  # export
     def add_arguments(self, parser: ArgumentParser) -> None:
         super().add_arguments(parser)
         parser.add_argument('names', nargs = '*', help = 'Package names')
+
+__all__ = ['NamedPkgsCmd', 'Parent']

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

@@ -1,13 +1,11 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from ...CmdBase import CmdBase as Base
-
+from ..CmdPlatform import CmdPlatform as Parent
-if TYPE_CHECKING:
-    from ..CmdPlatform import CmdPlatform
-
-from ..Cmd import Cmd as Base
 
 class Cmd(Base):  # export
 
-    def __init__(self, parent: CmdPlatform, name: str, help: str) -> None:
+    def __init__(self, parent: Parent, name: str, help: str) -> None:
         super().__init__(parent, name, help)
+
+__all__ = ['Parent', 'Cmd']

src/python/jw/pkg/cmds/platform/CmdInfo.py

@@ -1,12 +1,16 @@
-from argparse import ArgumentParser, Namespace
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
 
 from ...lib.Distro import Distro
-from ..Cmd import Cmd
+from .Cmd import Cmd, Parent
-from ..CmdPlatform import CmdPlatform
+
+if TYPE_CHECKING:
+    from argparse import ArgumentParser, Namespace
 
 class CmdInfo(Cmd):  # export
 
-    def __init__(self, parent: CmdPlatform) -> None:
+    def __init__(self, parent: Parent) -> None:
         super().__init__(
             parent, 'info', help = 'Retrieve information about target platform'
         )