Merge pull request #32 from bckohan/pyright

Pyright

Author: bckohan

.github/workflows/lint.yml

@@ -9,23 +9,31 @@ jobs:
     strategy:
       matrix:
         # run static analysis on bleeding and trailing edges
-        python-version: [ '3.8', '3.12' ]
+        python-version: [ '3.8', '3.10', '3.12' ]
         django-version:
-          - 'Django~=3.2.0' # LTS April 2024
-          - 'Django~=4.2.0' # LTS April 2026
+          - '3.2' # LTS April 2024
+          - '4.2' # LTS April 2026
+          - '5.0' # April 2025
         exclude:
           - python-version: '3.8'
-            django-version: 'Django~=4.2.0'
+            django-version: '4.2'
           - python-version: '3.12'
-            django-version: 'Django~=3.2.0'
+            django-version: '4.2'
+          - python-version: '3.12'
+            django-version: '3.2'
+          - python-version: '3.10'
+            django-version: '3.2'
+          - python-version: '3.8'
+            django-version: '5.0'
+          - python-version: '3.10'
+            django-version: '5.0'
 
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-
       - name: Install Poetry
         uses: snok/install-poetry@v1
         with:
@@ -36,15 +44,20 @@ jobs:
           poetry config virtualenvs.in-project true
           poetry run pip install --upgrade pip
           poetry install
-          poetry run pip install -U "${{ matrix.django-version }}"
+          poetry run pip install -U "django~=${{ matrix.django-version }}"
       - name: Run Static Analysis
         run: |
-          poetry run isort django_typer --check
-          poetry run black django_typer --check
-          poetry run pylint django_typer
-          poetry run mypy django_typer
+          source .venv/bin/activate
+          isort django_typer --check
+          black django_typer --check
+          pylint django_typer
+          mypy django_typer
           poetry check
-          poetry run pip check
-          poetry run python -m readme_renderer ./README.rst -o /tmp/README.html
+          pip check
+          python -m readme_renderer ./README.rst -o /tmp/README.html
           cd ./doc
-          poetry run doc8 --ignore-path build --max-line-length 100
+          doc8 --ignore-path build --max-line-length 100
+          echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
+
+      - name: Run pyright
+        uses: jakebailey/pyright-action@v2

CONTRIBUTING.rst

@@ -8,6 +8,7 @@
 .. _readthedocs: https://readthedocs.org/
 .. _me: https://github.com/bckohan
 .. _black: https://black.readthedocs.io/en/stable/
+.. _pyright: https://github.com/microsoft/pyright
 
 Contributing
 ############
@@ -51,7 +52,7 @@ then run Sphinx_:
 Static Analysis
 ---------------
 
-`django-typer` uses Pylint_ for python linting and mypy_ for static type
+`django-typer` uses Pylint_ for python linting and mypy_ and pyright_ for static type
 checking. Header imports are also standardized using isort_ and formatting is
 done with black_. Before any PR is accepted the following must be run, and
 static analysis tools should not produce any errors or warnings. Disabling
@@ -63,6 +64,7 @@ certain errors or warnings where justified is acceptable:
     poetry run black django_typer
     poetry run pylint django_typer
     poetry run mypy django_typer
+    pyright
     poetry check
     poetry run pip check
     poetry run python -m readme_renderer ./README.rst

django_typer/__init__.py

@@ -76,6 +76,7 @@
 from django.core.management import get_commands
 from django.core.management.base import BaseCommand, CommandError
 from django.core.management.base import OutputWrapper as BaseOutputWrapper
+from django.core.management.color import Style as ColorStyle
 from django.db.models import Model
 from django.utils.translation import gettext as _
 
@@ -89,15 +90,21 @@
 from typer.core import TyperGroup as CoreTyperGroup
 from typer.main import get_command as get_typer_command
 from typer.main import get_params_convertors_ctx_param_name_from_function
-from typer.models import CommandFunctionType
 from typer.models import Context as TyperContext
 from typer.models import Default, DefaultPlaceholder
 
 from .completers import ModelObjectCompleter
 from .parsers import ModelObjectParser
-from .types import ForceColor, NoColor, PythonPath, Settings, SkipChecks
-from .types import Style as ColorStyle
-from .types import Traceback, Verbosity, Version
+from .types import (
+    ForceColor,
+    NoColor,
+    PythonPath,
+    Settings,
+    SkipChecks,
+    Traceback,
+    Verbosity,
+    Version,
+)
 from .utils import _command_context, traceback_config, with_typehint
 
 VERSION = (1, 0, 1)
@@ -713,7 +720,7 @@ def subcommand(self):
             this can be used to group commands into panels in the help output.
         """
 
-        def create_app(func: CommandFunctionType):
+        def create_app(func: t.Callable[..., t.Any]):
             grp = GroupFunction(  # type: ignore
                 name=name,
                 cls=cls,
@@ -855,7 +862,7 @@ def divide(
         this can be used to group commands into panels in the help output.
     """
 
-    def decorator(func: CommandFunctionType):
+    def decorator(func: t.Callable[..., t.Any]):
         setattr(
             func,
             "_typer_callback_",
@@ -958,7 +965,7 @@ def other_command(self):
         this can be used to group commands into panels in the help output.
     """
 
-    def decorator(func: CommandFunctionType):
+    def decorator(func: t.Callable[..., t.Any]):
         setattr(
             func,
             "_typer_command_",
@@ -1071,7 +1078,7 @@ def subcommand(self):
         this can be used to group commands into panels in the help output.
     """
 
-    def create_app(func: CommandFunctionType):
+    def create_app(func: t.Callable[..., t.Any]):
         grp = GroupFunction(  # type: ignore
             name=name,
             cls=cls,
@@ -1199,8 +1206,9 @@ def __new__(
         This method is called when a new class is created.
         """
         try:
-            TyperCommand  # pylint: disable=pointless-statement
-            is_base_init = False
+            # avoid unnecessary work creating the TyperCommand class
+            # is there a less weird way to do this?
+            is_base_init = not TyperCommand
         except NameError:
             is_base_init = True
         typer_app = None
@@ -1267,7 +1275,7 @@ def __init__(cls, name, bases, attrs, **kwargs):
                 for arg in cls.suppressed_base_arguments or []
             }  # per django docs - allow these to be specified by either the option or param name
 
-            def get_ctor(attr: str) -> t.Optional[t.Callable[..., t.Any]]:
+            def get_ctor(attr: t.Any) -> t.Optional[t.Callable[..., t.Any]]:
                 return getattr(
                     attr, "_typer_command_", getattr(attr, "_typer_callback_", None)
                 )
@@ -1671,19 +1679,20 @@ def command2(self, option: t.Optional[str] = None):
     style: ColorStyle
     stdout: BaseOutputWrapper
     stderr: BaseOutputWrapper
-    requires_system_checks: t.Union[t.Sequence[str], str]
+    # requires_system_checks: t.Union[t.List[str], t.Tuple[str, ...], t.Literal['__all__']]
 
     # we do not use verbosity because the base command does not do anything with it
     # if users want to use a verbosity flag like the base django command adds
     # they can use the type from django_typer.types.Verbosity
-    suppressed_base_arguments: t.Optional[t.Iterable[str]] = {"verbosity"}
+    suppressed_base_arguments = {"verbosity"}
 
     typer_app: Typer
     no_color: bool = False
     force_color: bool = False
     _num_commands: int = 0
     _has_callback: bool = False
     _root_groups: int = 0
+    _handle: t.Callable[..., t.Any]
 
     command_tree: CommandNode
 
@@ -1701,8 +1710,8 @@ def __exit__(self, exc_type, exc_val, exc_tb):
 
     def __init__(
         self,
-        stdout: t.Optional[t.IO[str]] = None,
-        stderr: t.Optional[t.IO[str]] = None,
+        stdout: t.Optional[t.TextIO] = None,
+        stderr: t.Optional[t.TextIO] = None,
         no_color: bool = no_color,
         force_color: bool = force_color,
         **kwargs,
@@ -1795,7 +1804,9 @@ def __init_subclass__(cls, **_):
         """Avoid passing typer arguments up the subclass init chain"""
         return super().__init_subclass__()
 
-    def create_parser(self, prog_name: str, subcommand: str, **_):
+    def create_parser(  # pyright: ignore[reportIncompatibleMethodOverride]
+        self, prog_name: str, subcommand: str, **_
+    ):
         """
         Create a parser for this command. This also sets the command
         context, so any functions below this call on the stack may
@@ -1862,7 +1873,7 @@ def handle(self, option1: bool, option2: bool):
         :param kwargs: the options to directly pass to handle()
         """
         with self:
-            if getattr(self, "_handle", None):
+            if getattr(self, "_handle", None) and callable(self._handle):
                 return self._handle(*args, **kwargs)
             raise NotImplementedError(
                 _(

django_typer/apps.py

@@ -24,13 +24,14 @@
 
 try:
     import rich
+    from rich import traceback
 
     tb_config = traceback_config()
     if rich and isinstance(tb_config, dict) and not tb_config.get("no_install", False):
         # install rich tracebacks if we've been configured to do so (default)
         no_color = "NO_COLOR" in os.environ
         force_color = "FORCE_COLOR" in os.environ
-        rich.traceback.install(
+        traceback.install(
             console=tb_config.pop(
                 "console",
                 (
@@ -48,8 +49,7 @@
             **{
                 param: value
                 for param, value in tb_config.items()
-                if param
-                in set(inspect.signature(rich.traceback.install).parameters.keys())
+                if param in set(inspect.signature(traceback.install).parameters.keys())
             },
         )
 except ImportError:
@@ -62,7 +62,7 @@ def check_traceback_config(app_configs, **kwargs) -> t.List[CheckMessage]:
     A system check that validates that the traceback config is valid and
     contains only the expected parameters.
     """
-    warnings = []
+    warnings: t.List[CheckMessage] = []
     tb_cfg = traceback_config()
     if isinstance(tb_cfg, dict):
         if rich:

django_typer/completers.py

@@ -255,7 +255,9 @@ def __init__(
         distinct: bool = distinct,
     ):
         self.model_cls = model_cls
-        self.lookup_field = lookup_field or model_cls._meta.pk.name
+        self.lookup_field = str(
+            lookup_field or getattr(self.model_cls._meta.pk, "name", "id")
+        )
         self.help_field = help_field
         self.limit = limit
         self.case_insensitive = case_insensitive
@@ -322,9 +324,9 @@ def __call__(
                 ],
                 help=getattr(obj, self.help_field, None) if self.help_field else "",
             )
-            for obj in self.model_cls.objects.filter(completion_qry).distinct()[
-                0 : self.limit
-            ]
+            for obj in getattr(self.model_cls, "objects")
+            .filter(completion_qry)
+            .distinct()[0 : self.limit]
             if (
                 getattr(obj, self.lookup_field) is not None
                 and str(getattr(obj, self.lookup_field))