Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add setuptools stubs #5762

Merged
merged 26 commits into from
Sep 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
ec7e522
Bump setuptools to 57.1
srittau Jul 11, 2021
b0713df
Add setuptools, generated by stubgen
srittau Jul 11, 2021
8fd0e8b
Remove vendored distutils
srittau Jul 11, 2021
5d8ae32
Remove vendored imp module
srittau Jul 11, 2021
e9abc99
Remove pt34compat
srittau Jul 11, 2021
ebc7114
Remove command.py36compat.pyi
srittau Jul 11, 2021
000998b
Revert "Remove command.py36compat.pyi"
srittau Jul 11, 2021
071fbf5
Import cleanup
srittau Jul 11, 2021
4dd877e
Fix problems flagged by flake8
srittau Jul 11, 2021
5caed43
Add __version__
srittau Jul 11, 2021
659d99b
Annotate setuptools.__init__
srittau Jul 11, 2021
a48ff3b
Exclude setuptools from stricter pyright checks
srittau Jul 11, 2021
6323ffe
Use correct function alias
srittau Jul 12, 2021
0b88bb1
Merge remote-tracking branch 'upstream/master' into setuptools
srittau Jul 13, 2021
1f17228
Merge branch 'master' into setuptools
srittau Jul 25, 2021
82e099b
Various fixes
srittau Jul 25, 2021
2ab4b2e
Add generic argument to CommandSpec's base class
srittau Jul 25, 2021
d72ff87
Use List, not list for base class
srittau Jul 25, 2021
abcebe6
sdist_add_defaults.add_defaults() only available before Python 3.7
srittau Jul 25, 2021
d8f236f
Bump version to 57.4
srittau Jul 25, 2021
99a3e0b
Annotate NonDataProperty
srittau Jul 25, 2021
2629c19
Work around a pytype import problem
srittau Jul 27, 2021
6f9fa34
pytype workaround
srittau Jul 27, 2021
bb51de2
unblock setuptools PR
Aug 2, 2021
da2929e
Merge branch 'master' into setuptools
srittau Aug 9, 2021
ee397c7
Merge branch 'master' into setuptools
JelleZijlstra Sep 19, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pyrightconfig.stricter.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
"stubs/requests",
"stubs/selenium",
"stubs/Send2Trash",
"stubs/setuptools",
"stubs/simplejson",
"stubs/slumber",
"stubs/stripe",
Expand Down
2 changes: 1 addition & 1 deletion stubs/setuptools/METADATA.toml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
version = "57.0"
version = "57.4"
77 changes: 77 additions & 0 deletions stubs/setuptools/setuptools/__init__.pyi
Original file line number Diff line number Diff line change
@@ -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): ...
1 change: 1 addition & 0 deletions stubs/setuptools/setuptools/_deprecation_warning.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
class SetuptoolsDeprecationWarning(Warning): ...
12 changes: 12 additions & 0 deletions stubs/setuptools/setuptools/archive_util.pyi
Original file line number Diff line number Diff line change
@@ -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
30 changes: 30 additions & 0 deletions stubs/setuptools/setuptools/build_meta.pyi
Original file line number Diff line number Diff line change
@@ -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
Empty file.
18 changes: 18 additions & 0 deletions stubs/setuptools/setuptools/command/alias.pyi
Original file line number Diff line number Diff line change
@@ -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): ...
48 changes: 48 additions & 0 deletions stubs/setuptools/setuptools/command/bdist_egg.pyi
Original file line number Diff line number Diff line change
@@ -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 = ...): ...
4 changes: 4 additions & 0 deletions stubs/setuptools/setuptools/command/bdist_rpm.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import distutils.command.bdist_rpm as orig

class bdist_rpm(orig.bdist_rpm):
def run(self) -> None: ...
4 changes: 4 additions & 0 deletions stubs/setuptools/setuptools/command/build_clib.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import distutils.command.build_clib as orig

class build_clib(orig.build_clib):
def build_libraries(self, libraries) -> None: ...
44 changes: 44 additions & 0 deletions stubs/setuptools/setuptools/command/build_ext.pyi
Original file line number Diff line number Diff line change
@@ -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: ...
27 changes: 27 additions & 0 deletions stubs/setuptools/setuptools/command/build_py.pyi
Original file line number Diff line number Diff line change
@@ -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): ...
31 changes: 31 additions & 0 deletions stubs/setuptools/setuptools/command/develop.pyi
Original file line number Diff line number Diff line change
@@ -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): ...
10 changes: 10 additions & 0 deletions stubs/setuptools/setuptools/command/dist_info.pyi
Original file line number Diff line number Diff line change
@@ -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: ...
Loading