Refactor, typing improvements, ci improvements

.forgejo/workflows/build-release.yaml

@@ -6,7 +6,7 @@ on:
       - '[0-9]+\.[0-9]+\.[0-9]'
 
 jobs:
-  backend-pylint:
+  lint-and-typing:
     runs-on: docker
     container: nikolaik/python-nodejs:python3.11-nodejs21
     steps:
@@ -15,15 +15,20 @@ jobs:
       - name: Install packages
         run: |
           pip install -e . -q
+          pip install pylint~=2.17.7 mypy~=1.10.1 --disable-pip-version-check -q
+          mypy --install-types
           python -m pip list --format=columns --disable-pip-version-check
-          pip install pylint~=2.17.7 --disable-pip-version-check -q
       - name: Run pylint
         run: |
           pylint --version
           pylint **/*.py --exit-zero --rc-file pyproject.toml
+      - name: Run mypy
+        run: |
+          mypy --version
+          mypy .
 
   build-artifacts:
-    needs: ["backend-pylint"]
+    needs: ["lint-and-typing"]
     runs-on: docker
     container: nikolaik/python-nodejs:python3.11-nodejs21
     steps:

.forgejo/workflows/check.yaml

@@ -3,7 +3,7 @@ on:
     branches: "**"
 
 jobs:
-  backend-pylint:
+  pylint:
     runs-on: docker
     container: nikolaik/python-nodejs:python3.11-nodejs21
     steps:
@@ -12,9 +12,26 @@ jobs:
       - name: Install packages
         run: |
           pip install -e . -q
-          python -m pip list --format=columns --disable-pip-version-check
           pip install pylint~=2.17.7 --disable-pip-version-check -q
+          python -m pip list --format=columns --disable-pip-version-check
       - name: Run pylint
         run: |
           pylint --version
           pylint **/*.py --exit-zero --rc-file pyproject.toml
+
+  typing-mypy:
+    runs-on: docker
+    container: nikolaik/python-nodejs:python3.11-nodejs21
+    steps:
+      - name: Checkout source code
+        uses: https://code.forgejo.org/actions/checkout@v3
+      - name: Install packages
+        run: |
+          pip install -e . -q
+          pip install mypy~=1.10.1 --disable-pip-version-check -q
+          mypy --install-types
+          python -m pip list --format=columns --disable-pip-version-check
+      - name: Run mypy
+        run: |
+          mypy --version
+          mypy .

dockge_cli/client/commandprovider/bindings.py

@@ -1,10 +1,10 @@
 from urllib.parse import urlparse
 from getpass import getpass
 
-from ...models.parser import Credentials
+from ...models import Credentials
 from ...service import storage
-from ..utils import stack_formatter, status_formatter, generic_formatter, get_credential_parser
 from ...service.communicate import DockgeConnection
+from ..utils import stack_formatter, status_formatter, generic_formatter, get_credential_parser
 
 class ExecutionCommands():
     @staticmethod

dockge_cli/client/commandprovider/descriptors.py

@@ -1,88 +1,90 @@
+from typing import List
+from ...models import Command
 from .bindings import ExecutionCommands
 
-command_mappings = [
+mapping: List[Command] = [
-    {
+    Command(
-        "command": "host",
+        cmd="host",
-        "description": "Sets and gets the URI of the dockge instance. Remove any unnecessary subdomains/protocols from the URI",
+        description="Sets and gets the URI of the dockge instance. Remove any unnecessary subdomains/protocols from the URI",
-        "args": 1,
+        args=1,
-        "optional": True,
+        optional=True,
-        "binding":    ExecutionCommands.host
+        bind=ExecutionCommands.host
-    },
+    ),
-    {
+    Command(
-        "command": "login",
+        cmd="login",
-        "description": "Logs into a given dockge account, either with an interactive dialogue or by passing --user and --password",
+        description="Logs into a given dockge account, either with an interactive dialogue or by passing --user and --password",
-        "args": 2,
+        args=2,
-        "optional": True,
+        optional=True,
-        "binding":   ExecutionCommands.login
+        bind=ExecutionCommands.login
-    },
+    ),
-    {
+    Command(
-        "command": "logout",
+        cmd="logout",
-        "description": "Removes the credentials from the local storage.",
+        description="Removes the credentials from the local storage.",
-        "args": 0,
+        args=0,
-        "optional": False,
+        optional=False,
-        "binding": ExecutionCommands.logout
+        bind=ExecutionCommands.logout
-    },
+    ),
-    {
+    Command(
-        "command": "list",
+        cmd="list",
-        "description": "Lists all available stacks with their status",
+        description="Lists all available stacks with their status",
-        "args": 0,
+        args=0,
-        "optional": False,
+        optional=False,
-        "binding": ExecutionCommands.list
+        bind=ExecutionCommands.list
-    },
+    ),
-    {
+    Command(
-        "command": "status",
+        cmd="status",
-        "description": "Returns the status of one stack",
+        description="Returns the status of one stack",
-        "args": 1,
+        args=1,
-        "optional": False,
+        optional=False,
-        "binding": ExecutionCommands.status
+        bind=ExecutionCommands.status
-    },
+    ),
-    {
+    Command(
-        "command": "restart",
+        cmd="restart",
-        "description": "Restarts a given stack",
+        description="Restarts a given stack",
-        "args": 1,
+        args=1,
-        "optional": False,
+        optional=False,
-        "binding": ExecutionCommands.restart
+        bind=ExecutionCommands.restart
-    },
+    ),
-    {
+    Command(
-        "command": "start",
+        cmd="start",
-        "description": "Starts a given stack",
+        description="Starts a given stack",
-        "args": 1,
+        args=1,
-        "optional": False,
+        optional=False,
-        "binding": ExecutionCommands.start
+        bind=ExecutionCommands.start
-    },
+    ),
-    {
+    Command(
-        "command": "stop",
+        cmd="stop",
-        "description": "Stops a given stack",
+        description="Stops a given stack",
-        "args": 1,
+        args=1,
-        "optional": False,
+        optional=False,
-        "binding": ExecutionCommands.stop
+        bind=ExecutionCommands.stop
-    },
+    ),
-    {
+    Command(
-        "command": "down",
+        cmd="down",
-        "description": "Stop & Downs a given stack",
+        description="Stop & Downs a given stack",
-        "args": 1,
+        args=1,
-        "optional": False,
+        optional=False,
-        "binding": ExecutionCommands.down
+        bind=ExecutionCommands.down
-    },
+    ),
-    {
+    Command(
-        "command": "update",
+        cmd="update",
-        "description": "Updates a stack",
+        description="Updates a stack",
-        "args": 1,
+        args=1,
-        "optional": False,
+        optional=False,
-        "binding": ExecutionCommands.update
+        bind=ExecutionCommands.update
-    },
+    ),
-    {
+    Command(
-        "command": "exit",
+        cmd="exit",
-        "description": "Exits the CLI - this will reset all settings, including credentials and host",
+        description="Exits the CLI - this will reset all settings, including credentials and host",
-        "args": 0,
+        args=0,
-        "optional": False,
+        optional=False,
-        "binding": ExecutionCommands.exit
+        bind=ExecutionCommands.exit
-    },
+    ),
-    {
+    Command(
-        "command": "help",
+        cmd="help",
-        "description": "Displays helping hints for commands",
+        description="Displays helping hints for commands",
-        "args": 1,
+        args=1,
-        "optional": True,
+        optional=True,
-        "binding": ExecutionCommands.help
+        bind=ExecutionCommands.help
-    }
+    )
 ]

dockge_cli/client/commandprovider/factory.py

@@ -1,17 +1,7 @@
-from typing import List, Callable
+from ...models import Command
-from pydantic import BaseModel
+from .descriptors import mapping
-from .descriptors import command_mappings
-
-class Command(BaseModel):
-    command: str
-    description: str
-    args: int
-    optional: bool
-    binding: Callable
 
 commands: dict[str, Command] = {}
-descriptors: List[dict[str, object]] = command_mappings
 
-for descriptor in descriptors:
+for descriptor in mapping:
-    c = Command(**descriptor) # type: ignore
+    commands.update({ descriptor.cmd: descriptor  })
-    commands.update({ c.command: c  })

dockge_cli/client/parser.py

@@ -2,7 +2,7 @@ import argparse
 import sys
 
 from .. import __version__
-from ..models.parser import Arguments
+from ..models import Arguments
 from .commandprovider.factory import commands
 
 def parse_arguments():

dockge_cli/models/__init__.py

@@ -1 +1,3 @@
 from .codes import StackStatus
+from .commands import Command
+from .parser import Arguments, Credentials

dockge_cli/models/commands.py

@@ -0,0 +1,9 @@
+from typing import Callable
+from pydantic import BaseModel
+
+class Command(BaseModel):
+    cmd: str
+    bind: Callable
+    args: int
+    optional: bool
+    description: str

pyproject.toml

@@ -34,6 +34,15 @@ include = ["dockge_cli*"]
 [tool.pylint."MAIN"]
 disable = [ "line-too-long", "missing-module-docstring", "missing-function-docstring", "missing-class-docstring" ]
 
+[tool.mypy]
+python_version = "3.11"
+warn_return_any = true
+warn_unused_configs = true
+
+[[tool.mypy.overrides]]
+module = 'socketio.*'
+ignore_missing_imports = true
+
 [build-system]
 requires = ["setuptools >= 61.0"]
 build-backend = "setuptools.build_meta"