Add setuptools stubs (#5762)

Author: srittau

pyrightconfig.stricter.json

@@ -56,6 +56,7 @@
         "stubs/requests",
         "stubs/selenium",
         "stubs/Send2Trash",
+        "stubs/setuptools",
         "stubs/simplejson",
         "stubs/slumber",
         "stubs/stripe",

stubs/setuptools/METADATA.toml

@@ -1 +1 @@
-version = "57.0"
+version = "57.4"

stubs/setuptools/setuptools/__init__.pyi

@@ -0,0 +1,77 @@
+from abc import abstractmethod
+from collections.abc import Iterable, Mapping
+from distutils.core import Command as _Command
+from typing import Any, Type
+
+from setuptools._deprecation_warning import SetuptoolsDeprecationWarning as SetuptoolsDeprecationWarning
+from setuptools.depends import Require as Require
+from setuptools.dist import Distribution as Distribution
+from setuptools.extension import Extension as Extension
+
+__version__: str
+
+class PackageFinder:
+    @classmethod
+    def find(cls, where: str = ..., exclude: Iterable[str] = ..., include: Iterable[str] = ...) -> list[str]: ...
+
+class PEP420PackageFinder(PackageFinder): ...
+
+find_packages = PackageFinder.find
+find_namespace_packages = PEP420PackageFinder.find
+
+def setup(
+    *,
+    name: str = ...,
+    version: str = ...,
+    description: str = ...,
+    long_description: str = ...,
+    author: str = ...,
+    author_email: str = ...,
+    maintainer: str = ...,
+    maintainer_email: str = ...,
+    url: str = ...,
+    download_url: str = ...,
+    packages: list[str] = ...,
+    py_modules: list[str] = ...,
+    scripts: list[str] = ...,
+    ext_modules: list[Extension] = ...,
+    classifiers: list[str] = ...,
+    distclass: Type[Distribution] = ...,
+    script_name: str = ...,
+    script_args: list[str] = ...,
+    options: Mapping[str, Any] = ...,
+    license: str = ...,
+    keywords: list[str] | str = ...,
+    platforms: list[str] | str = ...,
+    cmdclass: Mapping[str, Type[Command]] = ...,
+    data_files: list[tuple[str, list[str]]] = ...,
+    package_dir: Mapping[str, str] = ...,
+    obsoletes: list[str] = ...,
+    provides: list[str] = ...,
+    requires: list[str] = ...,
+    command_packages: list[str] = ...,
+    command_options: Mapping[str, Mapping[str, tuple[Any, Any]]] = ...,
+    package_data: Mapping[str, list[str]] = ...,
+    include_package_data: bool = ...,
+    libraries: list[str] = ...,
+    headers: list[str] = ...,
+    ext_package: str = ...,
+    include_dirs: list[str] = ...,
+    password: str = ...,
+    fullname: str = ...,
+    **attrs: Any,
+) -> None: ...
+
+class Command(_Command):
+    command_consumes_arguments: bool
+    def __init__(self, dist: Distribution, **kw: Any) -> None: ...
+    def ensure_string_list(self, option: str | list[str]) -> None: ...
+    def reinitialize_command(self, command: _Command | str, reinit_subcommands: int = ..., **kw: Any) -> _Command: ...
+    @abstractmethod
+    def initialize_options(self) -> None: ...
+    @abstractmethod
+    def finalize_options(self) -> None: ...
+    @abstractmethod
+    def run(self) -> None: ...
+
+class sic(str): ...

stubs/setuptools/setuptools/_deprecation_warning.pyi

@@ -0,0 +1 @@
+class SetuptoolsDeprecationWarning(Warning): ...

stubs/setuptools/setuptools/archive_util.pyi

@@ -0,0 +1,12 @@
+from distutils.errors import DistutilsError
+from typing import Any
+
+class UnrecognizedFormat(DistutilsError): ...
+
+def default_filter(src, dst): ...
+def unpack_archive(filename, extract_dir, progress_filter=..., drivers: Any | None = ...) -> None: ...
+def unpack_directory(filename, extract_dir, progress_filter=...) -> None: ...
+def unpack_zipfile(filename, extract_dir, progress_filter=...) -> None: ...
+def unpack_tarfile(filename, extract_dir, progress_filter=...): ...
+
+extraction_drivers: Any

stubs/setuptools/setuptools/build_meta.pyi

@@ -0,0 +1,30 @@
+from typing import Any
+
+from setuptools import dist
+
+class SetupRequirementsError(BaseException):
+    specifiers: Any
+    def __init__(self, specifiers) -> None: ...
+
+class Distribution(dist.Distribution):
+    def fetch_build_eggs(self, specifiers) -> None: ...
+    @classmethod
+    def patch(cls) -> None: ...
+
+class _BuildMetaBackend:
+    def run_setup(self, setup_script: str = ...) -> None: ...
+    def get_requires_for_build_wheel(self, config_settings: Any | None = ...): ...
+    def get_requires_for_build_sdist(self, config_settings: Any | None = ...): ...
+    def prepare_metadata_for_build_wheel(self, metadata_directory, config_settings: Any | None = ...): ...
+    def build_wheel(self, wheel_directory, config_settings: Any | None = ..., metadata_directory: Any | None = ...): ...
+    def build_sdist(self, sdist_directory, config_settings: Any | None = ...): ...
+
+class _BuildMetaLegacyBackend(_BuildMetaBackend):
+    def run_setup(self, setup_script: str = ...) -> None: ...
+
+get_requires_for_build_wheel: Any
+get_requires_for_build_sdist: Any
+prepare_metadata_for_build_wheel: Any
+build_wheel: Any
+build_sdist: Any
+__legacy__: Any

stubs/setuptools/setuptools/command/__init__.pyi

@@ -0,0 +1,18 @@
+from typing import Any
+
+from setuptools.command.setopt import option_base
+
+def shquote(arg): ...
+
+class alias(option_base):
+    description: str
+    command_consumes_arguments: bool
+    user_options: Any
+    boolean_options: Any
+    args: Any
+    remove: Any
+    def initialize_options(self) -> None: ...
+    def finalize_options(self) -> None: ...
+    def run(self) -> None: ...
+
+def format_alias(name, aliases): ...

stubs/setuptools/setuptools/command/alias.pyi

@@ -0,0 +1,48 @@
+from typing import Any
+
+from setuptools import Command
+
+def strip_module(filename): ...
+def sorted_walk(dir) -> None: ...
+def write_stub(resource, pyfile) -> None: ...
+
+class bdist_egg(Command):
+    description: str
+    user_options: Any
+    boolean_options: Any
+    bdist_dir: Any
+    plat_name: Any
+    keep_temp: int
+    dist_dir: Any
+    skip_build: int
+    egg_output: Any
+    exclude_source_files: Any
+    def initialize_options(self) -> None: ...
+    egg_info: Any
+    def finalize_options(self) -> None: ...
+    def do_install_data(self) -> None: ...
+    def get_outputs(self): ...
+    def call_command(self, cmdname, **kw): ...
+    stubs: Any
+    def run(self) -> None: ...
+    def zap_pyfiles(self) -> None: ...
+    def zip_safe(self): ...
+    def gen_header(self): ...
+    def copy_metadata_to(self, target_dir) -> None: ...
+    def get_ext_outputs(self): ...
+
+NATIVE_EXTENSIONS: Any
+
+def walk_egg(egg_dir) -> None: ...
+def analyze_egg(egg_dir, stubs): ...
+def write_safety_flag(egg_dir, safe) -> None: ...
+
+safety_flags: Any
+
+def scan_module(egg_dir, base, name, stubs): ...
+def iter_symbols(code) -> None: ...
+def can_scan(): ...
+
+INSTALL_DIRECTORY_ATTRS: Any
+
+def make_zipfile(zip_filename, base_dir, verbose: int = ..., dry_run: int = ..., compress: bool = ..., mode: str = ...): ...

stubs/setuptools/setuptools/command/bdist_egg.pyi

@@ -0,0 +1,4 @@
+import distutils.command.bdist_rpm as orig
+
+class bdist_rpm(orig.bdist_rpm):
+    def run(self) -> None: ...

stubs/setuptools/setuptools/command/bdist_rpm.pyi

@@ -0,0 +1,4 @@
+import distutils.command.build_clib as orig
+
+class build_clib(orig.build_clib):
+    def build_libraries(self, libraries) -> None: ...

stubs/setuptools/setuptools/command/build_clib.pyi

@@ -0,0 +1,44 @@
+from distutils.command.build_ext import build_ext as _build_ext
+from typing import Any
+
+have_rtld: bool
+use_stubs: bool
+libtype: str
+
+def if_dl(s): ...
+def get_abi3_suffix(): ...
+
+class build_ext(_build_ext):
+    inplace: Any
+    def run(self) -> None: ...
+    def copy_extensions_to_source(self) -> None: ...
+    def get_ext_filename(self, fullname): ...
+    shlib_compiler: Any
+    shlibs: Any
+    ext_map: Any
+    def initialize_options(self) -> None: ...
+    extensions: Any
+    def finalize_options(self) -> None: ...
+    def setup_shlib_compiler(self) -> None: ...
+    def get_export_symbols(self, ext): ...
+    compiler: Any
+    def build_extension(self, ext) -> None: ...
+    def links_to_dynamic(self, ext): ...
+    def get_outputs(self): ...
+    def write_stub(self, output_dir, ext, compile: bool = ...) -> None: ...
+
+def link_shared_object(
+    self,
+    objects,
+    output_libname,
+    output_dir: Any | None = ...,
+    libraries: Any | None = ...,
+    library_dirs: Any | None = ...,
+    runtime_library_dirs: Any | None = ...,
+    export_symbols: Any | None = ...,
+    debug: int = ...,
+    extra_preargs: Any | None = ...,
+    extra_postargs: Any | None = ...,
+    build_temp: Any | None = ...,
+    target_lang: Any | None = ...,
+) -> None: ...

stubs/setuptools/setuptools/command/build_ext.pyi

@@ -0,0 +1,27 @@
+import distutils.command.build_py as orig
+from typing import Any
+
+from setuptools.lib2to3_ex import Mixin2to3
+
+def make_writable(target) -> None: ...
+
+class build_py(orig.build_py, Mixin2to3):
+    package_data: Any
+    exclude_package_data: Any
+    def finalize_options(self) -> None: ...
+    def run(self) -> None: ...
+    data_files: Any
+    def __getattr__(self, attr): ...
+    def build_module(self, module, module_file, package): ...
+    def find_data_files(self, package, src_dir): ...
+    def build_package_data(self) -> None: ...
+    manifest_files: Any
+    def analyze_manifest(self) -> None: ...
+    def get_data_files(self) -> None: ...
+    def check_package(self, package, package_dir): ...
+    packages_checked: Any
+    def initialize_options(self) -> None: ...
+    def get_package_dir(self, package): ...
+    def exclude_data_files(self, package, src_dir, files): ...
+
+def assert_relative(path): ...

stubs/setuptools/setuptools/command/build_py.pyi

@@ -0,0 +1,31 @@
+from typing import Any
+
+from setuptools import namespaces
+from setuptools.command.easy_install import easy_install
+
+class develop(namespaces.DevelopInstaller, easy_install):
+    description: str
+    user_options: Any
+    boolean_options: Any
+    command_consumes_arguments: bool
+    multi_version: bool
+    def run(self) -> None: ...  # type: ignore
+    uninstall: Any
+    egg_path: Any
+    setup_path: Any
+    always_copy_from: str
+    def initialize_options(self) -> None: ...
+    args: Any
+    egg_link: Any
+    egg_base: Any
+    dist: Any
+    def finalize_options(self) -> None: ...
+    def install_for_development(self) -> None: ...
+    def uninstall_link(self) -> None: ...
+    def install_egg_scripts(self, dist): ...
+    def install_wrapper_scripts(self, dist): ...
+
+class VersionlessRequirement:
+    def __init__(self, dist) -> None: ...
+    def __getattr__(self, name): ...
+    def as_requirement(self): ...

stubs/setuptools/setuptools/command/develop.pyi

@@ -0,0 +1,10 @@
+from distutils.core import Command
+from typing import Any
+
+class dist_info(Command):
+    description: str
+    user_options: Any
+    egg_base: Any
+    def initialize_options(self) -> None: ...
+    def finalize_options(self) -> None: ...
+    def run(self) -> None: ...