Fixes

Author: chadrik

pyproject.toml

@@ -8,8 +8,13 @@ exclude = [
     '.*/rez/data/.*',
     '.*/rez/vendor/.*',
     '.*/rez/tests/.*',
+    '.*/rez/utils/lint_helper.py',
 ]
 disable_error_code = ["var-annotated", "import-not-found"]
 check_untyped_defs = true
 # allow this for now:
-allow_redefinition = true
+allow_redefinition = true
+
+[[tool.mypy.overrides]]
+module = 'rez.utils.lint_helper'
+follow_imports = "skip"

src/rez/cli/benchmark.py

@@ -49,6 +49,8 @@ def load_packages():
     """
     from rez.packages import iter_package_families
 
+    assert pkg_repo_dir is not None
+
     print("Warming package cache...")
     fams = list(iter_package_families(paths=[pkg_repo_dir]))
 

src/rez/cli/interpret.py

@@ -47,7 +47,6 @@ def command(opts, parser, extra_arg_groups=None):
     with open(opts.FILE) as f:
         code = f.read()
 
-    interp = None
     if opts.format is None:
         interp = create_shell()
     elif opts.format in ('dict', 'table'):

src/rez/developer_package.py

@@ -2,6 +2,8 @@
 # Copyright Contributors to the Rez Project
 
 
+from __future__ import annotations
+
 from rez.config import config
 from rez.packages import Package, create_package
 from rez.serialise import load_from_file, FileFormat, set_objects
@@ -44,7 +46,7 @@ def root(self):
             return None
 
     @classmethod
-    def from_path(cls, path, format=None):
+    def from_path(cls, path, format: FileFormat | None = None):
         """Load a developer package.
 
         A developer package may for example be a package.yaml or package.py in a

src/rez/packages.py

@@ -27,6 +27,7 @@
 
 if TYPE_CHECKING:
     from typing import Literal  # not available in typing module until 3.8
+    from rez.config import Config
     from rez.developer_package import DeveloperPackage
     from rez.version import Requirement
     from rez.package_repository import PackageRepository
@@ -104,7 +105,7 @@ def uri(self):
         return self.resource.uri
 
     @property
-    def config(self):
+    def config(self) -> Config:
         """Returns the config for this package.
 
         Defaults to global config if this package did not provide a 'config'
@@ -685,12 +686,12 @@ def get_package_from_string(txt: str, paths: list[str] | None = None):
     return get_package(o.name, o.version, paths=paths)
 
 
-def get_developer_package(path: str, format: str | None = None) -> DeveloperPackage:
+def get_developer_package(path: str, format: FileFormat | None = None) -> DeveloperPackage:
     """Create a developer package.
 
     Args:
         path (str): Path to dir containing package definition file.
-        format (str): Package definition file format, detected if None.
+        format (FileFormat): Package definition file format, detected if None.
 
     Returns:
         `DeveloperPackage`.

src/rez/resolved_context.py

@@ -155,7 +155,7 @@ class ResolvedContext(object):
     """
     serialize_version = (4, 7)
     tmpdir_manager = TempDirs(config.context_tmpdir, prefix="rez_context_")
-    context_tracking_payload = None
+    context_tracking_payload: dict[str, Any] | None = None
     context_tracking_lock = threading.Lock()
     package_cache_present = True
     local = threading.local()
@@ -312,7 +312,7 @@ def __init__(self,
 
         # the pre-resolve bindings. We store these because @late package.py
         # functions need them, and we cache them to avoid cost
-        self.pre_resolve_bindings = None
+        self.pre_resolve_bindings: dict[str, Any] | None = None
 
         # suite information
         self.parent_suite_path = None
@@ -1145,7 +1145,7 @@ def get_environ(self, parent_environ=None) -> dict[str, str]:
         return executor.get_output()
 
     @_on_success
-    def get_key(self, key, request_only=False):
+    def get_key(self, key: str, request_only=False) -> dict[str, tuple[Variant, Any]]:
         """Get a data key value for each resolved package.
 
         Args:
@@ -1169,7 +1169,7 @@ def get_key(self, key, request_only=False):
         return values
 
     @_on_success
-    def get_tools(self, request_only=False):
+    def get_tools(self, request_only=False) -> dict[str, tuple[Variant, list[str]]]:
         """Returns the commandline tools available in the context.
 
         Args:
@@ -1182,7 +1182,7 @@ def get_tools(self, request_only=False):
         return self.get_key("tools", request_only=request_only)
 
     @_on_success
-    def get_tool_variants(self, tool_name):
+    def get_tool_variants(self, tool_name: str) -> set[Variant]:
         """Get the variant(s) that provide the named tool.
 
         If there are more than one variants, the tool is in conflict, and Rez
@@ -1203,7 +1203,7 @@ def get_tool_variants(self, tool_name):
         return variants
 
     @_on_success
-    def get_conflicting_tools(self, request_only=False):
+    def get_conflicting_tools(self, request_only=False) -> dict[str, set[Variant]]:
         """Returns tools of the same name provided by more than one package.
 
         Args:

src/rez/resolver.py

@@ -15,7 +15,7 @@
 from contextlib import contextmanager
 from enum import Enum
 from hashlib import sha1
-from typing import Callable, Sequence, TYPE_CHECKING
+from typing import Callable, TYPE_CHECKING
 
 if TYPE_CHECKING:
     from rez.package_order import PackageOrder
@@ -44,7 +44,7 @@ class Resolver(object):
     """
     def __init__(self,
                  context: ResolvedContext,
-                 package_requests: Sequence[Requirement],
+                 package_requests: list[Requirement],
                  package_paths: list[str],
                  package_filter: PackageFilterList | None = None,
                  package_orderers: list[PackageOrder] | None = None,

src/rez/rex.py

@@ -632,15 +632,15 @@ def __init__(self, target_environ=None, passive=False):
             are skipped.
         '''
         self.passive = passive
-        self.manager = None
+        self.manager: ActionManager | None = None
         if (target_environ is None) or (target_environ is os.environ):
             self.target_environ = os.environ
             self.update_session = True
         else:
             self.target_environ = target_environ
             self.update_session = False
 
-    def set_manager(self, manager):
+    def set_manager(self, manager: ActionManager):
         self.manager = manager
 
     def apply_environ(self):

src/rez/shells.py

@@ -26,7 +26,7 @@
     import subprocess
 
 
-def get_shell_types():
+def get_shell_types() -> list[str]:
     """Returns the available shell types: bash, tcsh etc.
 
     Returns:
@@ -36,7 +36,7 @@ def get_shell_types():
     return list(plugin_manager.get_plugins('shell'))
 
 
-def get_shell_class(shell=None):
+def get_shell_class(shell=None) -> type[Shell]:
     """Get the plugin class associated with the given or current shell.
 
     Returns:
@@ -49,7 +49,7 @@ def get_shell_class(shell=None):
             shell = system.shell
 
     from rez.plugin_managers import plugin_manager
-    return plugin_manager.get_plugin_class("shell", shell)
+    return plugin_manager.get_plugin_class("shell", shell, type=Shell)
 
 
 def create_shell(shell: str | None = None, **kwargs) -> Shell:
@@ -74,29 +74,29 @@ class Shell(ActionInterpreter):
     schema_dict = {"prompt": str}
 
     @classmethod
-    def name(cls):
+    def name(cls) -> str:
         """Plugin name.
         """
         raise NotImplementedError
 
     @classmethod
-    def executable_name(cls):
+    def executable_name(cls) -> str:
         """Name of executable to create shell instance.
         """
         return cls.name()
 
     @classmethod
-    def executable_filepath(cls):
+    def executable_filepath(cls) -> str:
         """Get full filepath to executable, or raise if not found.
         """
         return cls.find_executable(cls.executable_name())
 
     @property
-    def executable(self):
+    def executable(self) -> str:
         return self.__class__.executable_filepath()
 
     @classmethod
-    def is_available(cls):
+    def is_available(cls) -> bool:
         """Determine if the shell is available to instantiate.
 
         Returns:
@@ -108,7 +108,7 @@ def is_available(cls):
             return False
 
     @classmethod
-    def file_extension(cls):
+    def file_extension(cls) -> str:
         """Get the file extension associated with the shell.
 
         Returns:
@@ -139,7 +139,7 @@ def __init__(self):
     def _addline(self, line):
         self._lines.append(line)
 
-    def get_output(self, style=OutputStyle.file):
+    def get_output(self, style=OutputStyle.file) -> str:
         if style == OutputStyle.file:
             script = '\n'.join(self._lines) + '\n'
         else:  # eval style
@@ -240,7 +240,7 @@ def spawn_shell(self, context_file, tmpdir, rcfile=None, norc=False,
         raise NotImplementedError
 
     @classmethod
-    def convert_tokens(cls, value):
+    def convert_tokens(cls, value) -> str:
         """
         Converts any token like ${VAR} and $VAR to shell specific form.
         Uses the ENV_VAR_REGEX to correctly parse tokens.
@@ -257,7 +257,7 @@ def convert_tokens(cls, value):
         )
 
     @classmethod
-    def get_key_token(cls, key):
+    def get_key_token(cls, key) -> str:
         """
         Encodes the environment variable into the shell specific form.
         Shells might implement multiple forms, but the most common/safest
@@ -272,7 +272,7 @@ def get_key_token(cls, key):
         return cls.get_all_key_tokens(key)[0]
 
     @classmethod
-    def get_all_key_tokens(cls, key):
+    def get_all_key_tokens(cls, key) -> list[str]:
         """
         Encodes the environment variable into the shell specific forms.
         Shells might implement multiple forms, but the most common/safest
@@ -287,15 +287,15 @@ def get_all_key_tokens(cls, key):
         raise NotImplementedError
 
     @classmethod
-    def line_terminator(cls):
+    def line_terminator(cls) -> str:
         """
         Returns:
             str: default line terminator
         """
         raise NotImplementedError
 
     @classmethod
-    def join(cls, command):
+    def join(cls, command) -> str:
         """
         Note: Default to unix sh/bash- friendly behaviour.
 
@@ -328,10 +328,10 @@ class UnixShell(Shell):
     r"""
     A base class for common \*nix shells, such as bash and tcsh.
     """
-    rcfile_arg = None
-    norc_arg = None
-    histfile = None
-    histvar = None
+    rcfile_arg: str = None
+    norc_arg: str = None
+    histfile: str = None
+    histvar: str = None
     command_arg = '-c'
     stdin_arg = '-s'
     last_command_status = '$?'
@@ -518,21 +518,21 @@ def _create_ex():
                                  % (cmd_str, str(e)))
         return p
 
-    def resetenv(self, key, value, friends=None):
+    def resetenv(self, key, value, friends=None) -> None:
         self._addline(self.setenv(key, value))
 
-    def info(self, value):
+    def info(self, value) -> None:
         for line in value.split('\n'):
             line = self.escape_string(line)
             self._addline('echo %s' % line)
 
-    def error(self, value):
+    def error(self, value) -> None:
         for line in value.split('\n'):
             line = self.escape_string(line)
             self._addline('echo %s 1>&2' % line)
 
     # escaping is allowed in args, but not in program string
-    def command(self, value):
+    def command(self, value) -> None:
         if is_non_string_iterable(value):
             it = iter(value)
             cmd = EscapedString.disallow(next(it))
@@ -542,18 +542,18 @@ def command(self, value):
             value = EscapedString.disallow(value)
         self._addline(value)
 
-    def comment(self, value):
+    def comment(self, value) -> None:
         value = EscapedString.demote(value)
         for line in value.split('\n'):
             self._addline('# %s' % line)
 
-    def shebang(self):
+    def shebang(self) -> None:
         self._addline("#!%s" % self.executable)
 
     @classmethod
     def get_all_key_tokens(cls, key):
         return ["${%s}" % key, "$%s" % key]
 
     @classmethod
-    def line_terminator(cls):
+    def line_terminator(cls) -> str:
         return "\n"