burn down pyright errors

Author: bckohan

django_typer/__init__.py

@@ -89,7 +89,6 @@
 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
 
@@ -713,7 +712,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 +854,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 +957,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 +1070,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 +1198,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 +1267,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)
                 )

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:

django_typer/management/commands/shellcompletion.py

@@ -36,14 +36,15 @@
 else:
     from typing import Annotated
 
+from functools import cached_property
+
 from click.parser import split_arg_string
 from click.shell_completion import (
     CompletionItem,
     add_completion_class,
     get_completion_class,
 )
 from django.core.management import CommandError, ManagementUtility
-from django.utils.functional import cached_property
 from django.utils.module_loading import import_string
 from django.utils.translation import gettext
 from django.utils.translation import gettext_lazy as _
@@ -87,7 +88,7 @@ class Command(TyperCommand):
     cases users should refer to the online documentation for their specific shell to troubleshoot.
     """
 
-    help = _("Install autocompletion for the current shell.")
+    help = t.cast(str, _("Install autocompletion for the current shell."))
 
     # disable the system checks - no reason to run these for this one-off command
     requires_system_checks = []
@@ -134,7 +135,7 @@ def manage_script_name(self) -> str:
         """
         Get the name of the manage script as a command available from the shell's path.
         """
-        return getattr(self.manage_script, "name", self.manage_script)
+        return str(getattr(self.manage_script, "name", self.manage_script))
 
     @property
     def shell(self) -> Shells:
@@ -265,30 +266,40 @@ def replace(s: str, old: str, new: str, occurrences: t.List[int]) -> str:
             typer_scripts._completion_scripts[Shells.powershell.value] = script
             typer_scripts._completion_scripts[Shells.pwsh.value] = script
 
-    @command(help=_("Install autocompletion for the current or given shell."))
+    @command(
+        help=t.cast(str, _("Install autocompletion for the current or given shell."))
+    )
     def install(
         self,
         shell: Annotated[
             t.Optional[Shells],
             Argument(
-                help=_("Specify the shell to install or remove autocompletion for.")
+                help=t.cast(
+                    str, _("Specify the shell to install or remove autocompletion for.")
+                )
             ),
         ] = DETECTED_SHELL,
         manage_script: Annotated[
             t.Optional[str],
             Option(
-                help=_(
-                    "The name of the django manage script to install autocompletion for if "
-                    "different than the script used to invoke this command."
+                help=t.cast(
+                    str,
+                    _(
+                        "The name of the django manage script to install autocompletion for if "
+                        "different than the script used to invoke this command."
+                    ),
                 )
             ),
         ] = None,
         fallback: Annotated[
             t.Optional[str],
             Option(
-                help=_(
-                    "The python import path to a fallback complete function to use when "
-                    "the completion command is not a TyperCommand."
+                help=t.cast(
+                    str,
+                    _(
+                        "The python import path to a fallback complete function to use when "
+                        "the completion command is not a TyperCommand."
+                    ),
                 )
             ),
         ] = None,
@@ -311,7 +322,7 @@ def install(
         self.patch_script(fallback=fallback)
         install_path = install(
             shell=self.shell.value,
-            prog_name=manage_script or self.manage_script_name,
+            prog_name=str(manage_script or self.manage_script_name),
             complete_var=self.COMPLETE_VAR,
         )[1]
         self.stdout.write(
@@ -322,21 +333,29 @@ def install(
             )
         )
 
-    @command(help=_("Remove autocompletion for the current or given shell."))
+    @command(
+        help=t.cast(str, _("Remove autocompletion for the current or given shell."))
+    )
     def remove(
         self,
         shell: Annotated[
             t.Optional[Shells],
             Argument(
-                help=_("Specify the shell to install or remove shell completion for.")
+                help=t.cast(
+                    str,
+                    _("Specify the shell to install or remove shell completion for."),
+                )
             ),
         ] = DETECTED_SHELL,
         manage_script: Annotated[
             t.Optional[str],
             Option(
-                help=_(
-                    "The name of the django manage script to remove shell completion for if "
-                    "different than the script used to invoke this command."
+                help=t.cast(
+                    str,
+                    _(
+                        "The name of the django manage script to remove shell completion for if "
+                        "different than the script used to invoke this command."
+                    ),
                 )
             ),
         ] = None,
@@ -362,7 +381,7 @@ def remove(
         self.shell = shell  # type: ignore
         stdout = self.stdout
         self.stdout = io.StringIO()
-        prog_name = manage_script or self.manage_script_name
+        prog_name = str(manage_script or self.manage_script_name)
         installed_path = install(shell=self.shell.value, prog_name=prog_name)[1]
         if self.shell in [Shells.pwsh, Shells.powershell]:
             # annoyingly, powershell has one profile script for all completion commands
@@ -421,31 +440,41 @@ def remove(
             )
         )
 
-    @command(help=_("Generate autocompletion for command string."), hidden=False)
+    @command(
+        help=t.cast(str, _("Generate autocompletion for command string.")), hidden=False
+    )
     def complete(
         self,
         cmd_str: Annotated[
             t.Optional[str],
             Argument(
                 metavar="command",
-                help=_("The command string to generate completion suggestions for."),
+                help=t.cast(
+                    str, _("The command string to generate completion suggestions for.")
+                ),
             ),
         ] = None,
         shell: Annotated[
             t.Optional[Shells],
             Option(
-                help=_(
-                    "Specify the shell to fetch completion for, default will autodetect."
+                help=t.cast(
+                    str,
+                    _(
+                        "Specify the shell to fetch completion for, default will autodetect."
+                    ),
                 )
             ),
         ] = None,
         fallback: Annotated[
             t.Optional[str],
             Option(
-                help=_(
-                    "The python import path to a fallback complete function to use when "
-                    "the completion command is not a TyperCommand. By default, the builtin "
-                    "django autocomplete function is used."
+                help=t.cast(
+                    str,
+                    _(
+                        "The python import path to a fallback complete function to use when "
+                        "the completion command is not a TyperCommand. By default, the builtin "
+                        "django autocomplete function is used."
+                    ),
                 )
             ),
         ] = None,

django_typer/types.py

@@ -6,7 +6,7 @@
 
 import sys
 from pathlib import Path
-from typing import Any, Callable, Optional
+from typing import Any, Callable, Optional, cast
 
 if sys.version_info < (3, 9):
     from typing_extensions import Annotated
@@ -57,7 +57,7 @@ def set_force_color(context, param, value):
     bool,
     Option(
         "--version",
-        help=_("Show program's version number and exit."),
+        help=cast(str, _("Show program's version number and exit.")),
         callback=print_version,
         is_eager=True,
         rich_help_panel=COMMON_PANEL,
@@ -74,9 +74,12 @@ def set_force_color(context, param, value):
 Verbosity = Annotated[
     int,
     Option(
-        help=_(
-            "Verbosity level; 0=minimal output, 1=normal output, "
-            "2=verbose output, 3=very verbose output"
+        help=cast(
+            str,
+            _(
+                "Verbosity level; 0=minimal output, 1=normal output, "
+                "2=verbose output, 3=very verbose output"
+            ),
         ),
         show_choices=True,
         min=0,
@@ -101,10 +104,13 @@ def handle(self, verbosity: Verbosity = 1):
 Settings = Annotated[
     str,
     Option(
-        help=_(
-            "The Python path to a settings module, e.g. "
-            '"myproject.settings.main". If this isn\'t provided, the '
-            "DJANGO_SETTINGS_MODULE environment variable will be used."
+        help=cast(
+            str,
+            _(
+                "The Python path to a settings module, e.g. "
+                '"myproject.settings.main". If this isn\'t provided, the '
+                "DJANGO_SETTINGS_MODULE environment variable will be used."
+            ),
         ),
         rich_help_panel=COMMON_PANEL,
     ),
@@ -121,9 +127,12 @@ def handle(self, verbosity: Verbosity = 1):
 PythonPath = Annotated[
     Optional[Path],
     Option(
-        help=_(
-            "A directory to add to the Python path, e.g. "
-            '"/home/djangoprojects/myproject".'
+        help=cast(
+            str,
+            _(
+                "A directory to add to the Python path, e.g. "
+                '"/home/djangoprojects/myproject".'
+            ),
         ),
         rich_help_panel=COMMON_PANEL,
     ),
@@ -141,7 +150,7 @@ def handle(self, verbosity: Verbosity = 1):
     bool,
     Option(
         "--traceback",
-        help=_("Raise on CommandError exceptions"),
+        help=cast(str, _("Raise on CommandError exceptions")),
         rich_help_panel=COMMON_PANEL,
     ),
 ]
@@ -158,7 +167,7 @@ def handle(self, verbosity: Verbosity = 1):
     bool,
     Option(
         "--no-color",
-        help=_("Don't colorize the command output."),
+        help=cast(str, _("Don't colorize the command output.")),
         is_eager=True,
         callback=set_no_color,
         rich_help_panel=COMMON_PANEL,
@@ -177,7 +186,7 @@ def handle(self, verbosity: Verbosity = 1):
     bool,
     Option(
         "--force-color",
-        help=_("Force colorization of the command output."),
+        help=cast(str, _("Force colorization of the command output.")),
         is_eager=True,
         callback=set_force_color,
         rich_help_panel=COMMON_PANEL,
@@ -195,7 +204,9 @@ def handle(self, verbosity: Verbosity = 1):
 SkipChecks = Annotated[
     bool,
     Option(
-        "--skip-checks", help=_("Skip system checks."), rich_help_panel=COMMON_PANEL
+        "--skip-checks",
+        help=cast(str, _("Skip system checks.")),
+        rich_help_panel=COMMON_PANEL,
     ),
 ]
 """

pyproject.toml

@@ -188,3 +188,9 @@ disable = [
     'C0411', # wrong import order. I put them where they need to be!
     'W0603', # Using the global statement
 ]
+
+[tool.pyright]
+exclude = [
+    "django_typer/tests/**/*",
+    "django_typer/examples/**/*"
+]