py2docfx 0.1.13rc2012291__py3-none-any.whl → 0.1.13rc2022156__py3-none-any.whl

py2docfx/venv/venv1/Lib/site-packages/setuptools/_distutils/command/build_ext.py

@@ -4,12 +4,16 @@ Implements the Distutils 'build_ext' command, for building extension
 modules (currently limited to C extensions, should accommodate C++
 extensions ASAP)."""
 
+from __future__ import annotations
+
 import contextlib
 import os
 import re
 import sys
+from collections.abc import Callable
 from distutils._log import log
 from site import USER_BASE
+from typing import ClassVar
 
 from .._modified import newer_group
 from ..core import Command
@@ -98,9 +102,15 @@ class build_ext(Command):
         ('user', None, "add user include, library and rpath"),
     ]
 
-    boolean_options = ['inplace', 'debug', 'force', 'swig-cpp', 'user']
+    boolean_options: ClassVar[list[str]] = [
+        'inplace',
+        'debug',
+        'force',
+        'swig-cpp',
+        'user',
+    ]
 
-    help_options = [
+    help_options: ClassVar[list[tuple[str, str | None, str, Callable[[], object]]]] = [
         ('help-compiler', None, "list available compilers", show_compilers),
     ]
 
@@ -153,7 +163,7 @@ class build_ext(Command):
             # building third party extensions
             yield sysconfig.get_config_var('LIBDIR')
 
-    def finalize_options(self):  # noqa: C901
+    def finalize_options(self) -> None:  # noqa: C901
         from distutils import sysconfig
 
         self.set_undefined_options(
@@ -292,7 +302,7 @@ class build_ext(Command):
             except ValueError:
                 raise DistutilsOptionError("parallel should be an integer")
 
-    def run(self):  # noqa: C901
+    def run(self) -> None:  # noqa: C901
         from ..ccompiler import new_compiler
 
         # 'self.extensions', as supplied by setup.py, is a list of
@@ -364,7 +374,7 @@ class build_ext(Command):
         # Now actually compile and link everything.
         self.build_extensions()
 
-    def check_extensions_list(self, extensions):  # noqa: C901
+    def check_extensions_list(self, extensions) -> None:  # noqa: C901
         """Ensure that the list of extensions (presumably provided as a
         command option 'extensions') is valid, i.e. it is a list of
         Extension objects.  We also support the old-style list of 2-tuples,
@@ -472,7 +482,7 @@ class build_ext(Command):
         # "build" tree.
         return [self.get_ext_fullpath(ext.name) for ext in self.extensions]
 
-    def build_extensions(self):
+    def build_extensions(self) -> None:
         # First, sanity-check the 'extensions' list
         self.check_extensions_list(self.extensions)
         if self.parallel:
@@ -515,7 +525,7 @@ class build_ext(Command):
                 raise
             self.warn(f'building extension "{ext.name}" failed: {e}')
 
-    def build_extension(self, ext):
+    def build_extension(self, ext) -> None:
         sources = ext.sources
         if sources is None or not isinstance(sources, (list, tuple)):
             raise DistutilsSetupError(
@@ -676,7 +686,7 @@ class build_ext(Command):
 
     # -- Name generators -----------------------------------------------
     # (extension names, filenames, whatever)
-    def get_ext_fullpath(self, ext_name):
+    def get_ext_fullpath(self, ext_name: str) -> str:
         """Returns the path of the filename for a given extension.
 
         The file is located in `build_lib` or directly in the package
@@ -703,7 +713,7 @@ class build_ext(Command):
         #   package_dir/filename
         return os.path.join(package_dir, filename)
 
-    def get_ext_fullname(self, ext_name):
+    def get_ext_fullname(self, ext_name: str) -> str:
         """Returns the fullname of a given extension name.
 
         Adds the `package.` prefix"""
@@ -712,7 +722,7 @@ class build_ext(Command):
         else:
             return self.package + '.' + ext_name
 
-    def get_ext_filename(self, ext_name):
+    def get_ext_filename(self, ext_name: str) -> str:
         r"""Convert the name of an extension (eg. "foo.bar") into the name
         of the file from which it will be loaded (eg. "foo/bar.so", or
         "foo\bar.pyd").
@@ -723,13 +733,13 @@ class build_ext(Command):
         ext_suffix = get_config_var('EXT_SUFFIX')
         return os.path.join(*ext_path) + ext_suffix
 
-    def get_export_symbols(self, ext):
+    def get_export_symbols(self, ext: Extension) -> list[str]:
         """Return the list of symbols that a shared extension has to
         export.  This either uses 'ext.export_symbols' or, if it's not
         provided, "PyInit_" + module_name.  Only relevant on Windows, where
         the .pyd file (DLL) must export the module "PyInit_" function.
         """
-        name = ext.name.split('.')[-1]
+        name = self._get_module_name_for_symbol(ext)
         try:
             # Unicode module name support as defined in PEP-489
             # https://peps.python.org/pep-0489/#export-hook-name
@@ -744,7 +754,16 @@ class build_ext(Command):
             ext.export_symbols.append(initfunc_name)
         return ext.export_symbols
 
-    def get_libraries(self, ext):  # noqa: C901
+    def _get_module_name_for_symbol(self, ext):
+        # Package name should be used for `__init__` modules
+        # https://github.com/python/cpython/issues/80074
+        # https://github.com/pypa/setuptools/issues/4826
+        parts = ext.name.split(".")
+        if parts[-1] == "__init__" and len(parts) >= 2:
+            return parts[-2]
+        return parts[-1]
+
+    def get_libraries(self, ext: Extension) -> list[str]:  # noqa: C901
         """Return the list of libraries to link against when building a
         shared extension.  On most platforms, this is just 'ext.libraries';
         on Windows, we add the Python library (eg. python20.dll).

py2docfx/venv/venv1/Lib/site-packages/setuptools/_distutils/command/build_py.py

@@ -7,6 +7,7 @@ import importlib.util
 import os
 import sys
 from distutils._log import log
+from typing import ClassVar
 
 from ..core import Command
 from ..errors import DistutilsFileError, DistutilsOptionError
@@ -29,8 +30,8 @@ class build_py(Command):
         ('force', 'f', "forcibly build everything (ignore file timestamps)"),
     ]
 
-    boolean_options = ['compile', 'force']
-    negative_opt = {'no-compile': 'compile'}
+    boolean_options: ClassVar[list[str]] = ['compile', 'force']
+    negative_opt: ClassVar[dict[str, str]] = {'no-compile': 'compile'}
 
     def initialize_options(self):
         self.build_lib = None
@@ -42,7 +43,7 @@ class build_py(Command):
         self.optimize = 0
         self.force = None
 
-    def finalize_options(self):
+    def finalize_options(self) -> None:
         self.set_undefined_options(
             'build', ('build_lib', 'build_lib'), ('force', 'force')
         )
@@ -67,7 +68,7 @@ class build_py(Command):
             except (ValueError, AssertionError):
                 raise DistutilsOptionError("optimize must be 0, 1, or 2")
 
-    def run(self):
+    def run(self) -> None:
         # XXX copy_file by default preserves atime and mtime.  IMHO this is
         # the right thing to do, but perhaps it should be an option -- in
         # particular, a site administrator might want installed files to
@@ -134,7 +135,7 @@ class build_py(Command):
             ])
         return files
 
-    def build_package_data(self):
+    def build_package_data(self) -> None:
         """Copy data files into build directory"""
         for _package, src_dir, build_dir, filenames in self.data_files:
             for filename in filenames:
@@ -306,7 +307,7 @@ class build_py(Command):
         outfile_path = [build_dir] + list(package) + [module + ".py"]
         return os.path.join(*outfile_path)
 
-    def get_outputs(self, include_bytecode=True):
+    def get_outputs(self, include_bytecode: bool = True) -> list[str]:
         modules = self.find_all_modules()
         outputs = []
         for package, module, _module_file in modules:
@@ -349,7 +350,7 @@ class build_py(Command):
         self.mkpath(dir)
         return self.copy_file(module_file, outfile, preserve_mode=False)
 
-    def build_modules(self):
+    def build_modules(self) -> None:
         modules = self.find_modules()
         for package, module, module_file in modules:
             # Now "build" the module -- ie. copy the source file to
@@ -358,7 +359,7 @@ class build_py(Command):
             # under self.build_lib.)
             self.build_module(module, module_file, package)
 
-    def build_packages(self):
+    def build_packages(self) -> None:
         for package in self.packages:
             # Get list of (package, module, module_file) tuples based on
             # scanning the package directory.  'package' is only included
@@ -378,7 +379,7 @@ class build_py(Command):
                 assert package == package_
                 self.build_module(module, module_file, package)
 
-    def byte_compile(self, files):
+    def byte_compile(self, files) -> None:
         if sys.dont_write_bytecode:
             self.warn('byte-compiling is disabled, skipping.')
             return

py2docfx/venv/venv1/Lib/site-packages/setuptools/_distutils/command/build_scripts.py

@@ -5,7 +5,6 @@ Implements the Distutils 'build_scripts' command."""
 import os
 import re
 import tokenize
-from distutils import sysconfig
 from distutils._log import log
 from stat import ST_MODE
 from typing import ClassVar
@@ -32,7 +31,7 @@ class build_scripts(Command):
         ('executable=', 'e', "specify final destination interpreter path"),
     ]
 
-    boolean_options = ['force']
+    boolean_options: ClassVar[list[str]] = ['force']
 
     def initialize_options(self):
         self.build_dir = None
@@ -76,7 +75,7 @@ class build_scripts(Command):
 
         return outfiles, updated_files
 
-    def _copy_script(self, script, outfiles, updated_files):  # noqa: C901
+    def _copy_script(self, script, outfiles, updated_files):
         shebang_match = None
         script = convert_path(script)
         outfile = os.path.join(self.build_dir, os.path.basename(script))
@@ -106,18 +105,8 @@ class build_scripts(Command):
         if shebang_match:
             log.info("copying and adjusting %s -> %s", script, self.build_dir)
             if not self.dry_run:
-                if not sysconfig.python_build:
-                    executable = self.executable
-                else:
-                    executable = os.path.join(
-                        sysconfig.get_config_var("BINDIR"),
-                        "python{}{}".format(
-                            sysconfig.get_config_var("VERSION"),
-                            sysconfig.get_config_var("EXE"),
-                        ),
-                    )
                 post_interp = shebang_match.group(1) or ''
-                shebang = "#!" + executable + post_interp + "\n"
+                shebang = f"#!python{post_interp}\n"
                 self._validate_shebang(shebang, f.encoding)
                 with open(outfile, "w", encoding=f.encoding) as outf:
                     outf.write(shebang)

py2docfx/venv/venv1/Lib/site-packages/setuptools/_distutils/command/check.py

@@ -52,7 +52,7 @@ class check(Command):
         ('strict', 's', 'Will exit with an error if a check fails'),
     ]
 
-    boolean_options = ['metadata', 'restructuredtext', 'strict']
+    boolean_options: ClassVar[list[str]] = ['metadata', 'restructuredtext', 'strict']
 
     def initialize_options(self):
         """Sets default values for options."""

py2docfx/venv/venv1/Lib/site-packages/setuptools/_distutils/command/clean.py

@@ -6,6 +6,7 @@ Implements the Distutils 'clean' command."""
 
 import os
 from distutils._log import log
+from typing import ClassVar
 
 from ..core import Command
 from ..dir_util import remove_tree
@@ -30,7 +31,7 @@ class clean(Command):
         ('all', 'a', "remove all build output, not just temporary by-products"),
     ]
 
-    boolean_options = ['all']
+    boolean_options: ClassVar[list[str]] = ['all']
 
     def initialize_options(self):
         self.build_base = None

py2docfx/venv/venv1/Lib/site-packages/setuptools/_distutils/command/config.py

@@ -17,6 +17,7 @@ import re
 from collections.abc import Sequence
 from distutils._log import log
 
+from ..ccompiler import CCompiler, CompileError, LinkError, new_compiler
 from ..core import Command
 from ..errors import DistutilsExecError
 from ..sysconfig import customize_compiler
@@ -90,8 +91,6 @@ class config(Command):
         """
         # We do this late, and only on-demand, because this is an expensive
         # import.
-        from ..ccompiler import CCompiler, new_compiler
-
         if not isinstance(self.compiler, CCompiler):
             self.compiler = new_compiler(
                 compiler=self.compiler, dry_run=self.dry_run, force=True
@@ -177,8 +176,6 @@ class config(Command):
         preprocessor succeeded, false if there were any errors.
         ('body' probably isn't of much use, but what the heck.)
         """
-        from ..ccompiler import CompileError
-
         self._check_compiler()
         ok = True
         try:
@@ -213,8 +210,6 @@ class config(Command):
         """Try to compile a source file built from 'body' and 'headers'.
         Return true on success, false otherwise.
         """
-        from ..ccompiler import CompileError
-
         self._check_compiler()
         try:
             self._compile(body, headers, include_dirs, lang)
@@ -239,8 +234,6 @@ class config(Command):
         'headers', to executable form.  Return true on success, false
         otherwise.
         """
-        from ..ccompiler import CompileError, LinkError
-
         self._check_compiler()
         try:
             self._link(body, headers, include_dirs, libraries, library_dirs, lang)

py2docfx/venv/venv1/Lib/site-packages/setuptools/_distutils/command/install.py

@@ -2,6 +2,8 @@
 
 Implements the Distutils 'install' command."""
 
+from __future__ import annotations
+
 import contextlib
 import itertools
 import os
@@ -9,6 +11,7 @@ import sys
 import sysconfig
 from distutils._log import log
 from site import USER_BASE, USER_SITE
+from typing import ClassVar
 
 import jaraco.collections
 
@@ -238,7 +241,7 @@ class install(Command):
         ('record=', None, "filename in which to record list of installed files"),
     ]
 
-    boolean_options = ['compile', 'force', 'skip-build']
+    boolean_options: ClassVar[list[str]] = ['compile', 'force', 'skip-build']
 
     if HAS_USER_SITE:
         user_options.append((
@@ -248,15 +251,15 @@ class install(Command):
         ))
         boolean_options.append('user')
 
-    negative_opt = {'no-compile': 'compile'}
+    negative_opt: ClassVar[dict[str, str]] = {'no-compile': 'compile'}
 
-    def initialize_options(self):
+    def initialize_options(self) -> None:
         """Initializes options."""
         # High-level options: these select both an installation base
         # and scheme.
-        self.prefix = None
-        self.exec_prefix = None
-        self.home = None
+        self.prefix: str | None = None
+        self.exec_prefix: str | None = None
+        self.home: str | None = None
         self.user = False
 
         # These select only the installation base; it's up to the user to
@@ -264,7 +267,7 @@ class install(Command):
         # the --install-{platlib,purelib,scripts,data} options).
         self.install_base = None
         self.install_platbase = None
-        self.root = None
+        self.root: str | None = None
 
         # These options are the actual installation directories; if not
         # supplied by the user, they are filled in using the installation
@@ -273,7 +276,7 @@ class install(Command):
         self.install_purelib = None  # for pure module distributions
         self.install_platlib = None  # non-pure (dists w/ extensions)
         self.install_headers = None  # for C/C++ headers
-        self.install_lib = None  # set to either purelib or platlib
+        self.install_lib: str | None = None  # set to either purelib or platlib
         self.install_scripts = None
         self.install_data = None
         self.install_userbase = USER_BASE
@@ -327,7 +330,7 @@ class install(Command):
     # party Python modules on various platforms given a wide
     # array of user input is decided.  Yes, it's quite complex!)
 
-    def finalize_options(self):  # noqa: C901
+    def finalize_options(self) -> None:  # noqa: C901
         """Finalizes options."""
         # This method (and its helpers, like 'finalize_unix()',
         # 'finalize_other()', and 'select_scheme()') is where the default
@@ -510,7 +513,7 @@ class install(Command):
         # Punt on doc directories for now -- after all, we're punting on
         # documentation completely!
 
-    def dump_dirs(self, msg):
+    def dump_dirs(self, msg) -> None:
         """Dumps the list of user options."""
         if not DEBUG:
             return
@@ -530,7 +533,7 @@ class install(Command):
                 val = getattr(self, opt_name)
             log.debug("  %s: %s", opt_name, val)
 
-    def finalize_unix(self):
+    def finalize_unix(self) -> None:
         """Finalizes options for posix platforms."""
         if self.install_base is not None or self.install_platbase is not None:
             incomplete_scheme = (
@@ -579,7 +582,7 @@ class install(Command):
             self.install_platbase = self.exec_prefix
             self.select_scheme("posix_prefix")
 
-    def finalize_other(self):
+    def finalize_other(self) -> None:
         """Finalizes options for non-posix platforms"""
         if self.user:
             if self.install_userbase is None:
@@ -601,7 +604,7 @@ class install(Command):
                     f"I don't know how to install stuff on '{os.name}'"
                 )
 
-    def select_scheme(self, name):
+    def select_scheme(self, name) -> None:
         _select_scheme(self, name)
 
     def _expand_attrs(self, attrs):
@@ -613,12 +616,12 @@ class install(Command):
                 val = subst_vars(val, self.config_vars)
                 setattr(self, attr, val)
 
-    def expand_basedirs(self):
+    def expand_basedirs(self) -> None:
         """Calls `os.path.expanduser` on install_base, install_platbase and
         root."""
         self._expand_attrs(['install_base', 'install_platbase', 'root'])
 
-    def expand_dirs(self):
+    def expand_dirs(self) -> None:
         """Calls `os.path.expanduser` on install dirs."""
         self._expand_attrs([
             'install_purelib',
@@ -629,13 +632,13 @@ class install(Command):
             'install_data',
         ])
 
-    def convert_paths(self, *names):
+    def convert_paths(self, *names) -> None:
         """Call `convert_path` over `names`."""
         for name in names:
             attr = "install_" + name
             setattr(self, attr, convert_path(getattr(self, attr)))
 
-    def handle_extra_path(self):
+    def handle_extra_path(self) -> None:
         """Set `path_file` and `extra_dirs` using `extra_path`."""
         if self.extra_path is None:
             self.extra_path = self.distribution.extra_path
@@ -670,13 +673,13 @@ class install(Command):
         self.path_file = path_file
         self.extra_dirs = extra_dirs
 
-    def change_roots(self, *names):
+    def change_roots(self, *names) -> None:
         """Change the install directories pointed by name using root."""
         for name in names:
             attr = "install_" + name
             setattr(self, attr, change_root(self.root, getattr(self, attr)))
 
-    def create_home_path(self):
+    def create_home_path(self) -> None:
         """Create directories under ~."""
         if not self.user:
             return

py2docfx/venv/venv1/Lib/site-packages/setuptools/_distutils/command/install_data.py

@@ -10,6 +10,7 @@ from __future__ import annotations
 import functools
 import os
 from collections.abc import Iterable
+from typing import ClassVar
 
 from ..core import Command
 from ..util import change_root, convert_path
@@ -28,7 +29,7 @@ class install_data(Command):
         ('force', 'f', "force installation (overwrite existing files)"),
     ]
 
-    boolean_options = ['force']
+    boolean_options: ClassVar[list[str]] = ['force']
 
     def initialize_options(self):
         self.install_dir = None
@@ -38,7 +39,7 @@ class install_data(Command):
         self.data_files = self.distribution.data_files
         self.warn_dir = True
 
-    def finalize_options(self):
+    def finalize_options(self) -> None:
         self.set_undefined_options(
             'install',
             ('install_data', 'install_dir'),
@@ -46,7 +47,7 @@ class install_data(Command):
             ('force', 'force'),
         )
 
-    def run(self):
+    def run(self) -> None:
         self.mkpath(self.install_dir)
         for f in self.data_files:
             self._copy(f)

py2docfx/venv/venv1/Lib/site-packages/setuptools/_distutils/command/install_headers.py

@@ -17,7 +17,7 @@ class install_headers(Command):
         ('force', 'f', "force installation (overwrite existing files)"),
     ]
 
-    boolean_options = ['force']
+    boolean_options: ClassVar[list[str]] = ['force']
 
     def initialize_options(self):
         self.install_dir = None

py2docfx/venv/venv1/Lib/site-packages/setuptools/_distutils/command/install_lib.py

@@ -3,9 +3,12 @@
 Implements the Distutils 'install_lib' command
 (install all Python modules)."""
 
+from __future__ import annotations
+
 import importlib.util
 import os
 import sys
+from typing import Any, ClassVar
 
 from ..core import Command
 from ..errors import DistutilsOptionError
@@ -47,8 +50,8 @@ class install_lib(Command):
         ('skip-build', None, "skip the build steps"),
     ]
 
-    boolean_options = ['force', 'compile', 'skip-build']
-    negative_opt = {'no-compile': 'compile'}
+    boolean_options: ClassVar[list[str]] = ['force', 'compile', 'skip-build']
+    negative_opt: ClassVar[dict[str, str]] = {'no-compile': 'compile'}
 
     def initialize_options(self):
         # let the 'install' command dictate our installation directory
@@ -59,7 +62,7 @@ class install_lib(Command):
         self.optimize = None
         self.skip_build = None
 
-    def finalize_options(self):
+    def finalize_options(self) -> None:
         # Get all the information we need to install pure Python modules
         # from the umbrella 'install' command -- build (source) directory,
         # install (target) directory, and whether to compile .py files.
@@ -86,7 +89,7 @@ class install_lib(Command):
             if self.optimize not in (0, 1, 2):
                 raise DistutilsOptionError("optimize must be 0, 1, or 2")
 
-    def run(self):
+    def run(self) -> None:
         # Make sure we have built everything we need first
         self.build()
 
@@ -102,14 +105,15 @@ class install_lib(Command):
     # -- Top-level worker functions ------------------------------------
     # (called from 'run()')
 
-    def build(self):
+    def build(self) -> None:
         if not self.skip_build:
             if self.distribution.has_pure_modules():
                 self.run_command('build_py')
             if self.distribution.has_ext_modules():
                 self.run_command('build_ext')
 
-    def install(self):
+    # Any: https://typing.readthedocs.io/en/latest/guides/writing_stubs.html#the-any-trick
+    def install(self) -> list[str] | Any:
         if os.path.isdir(self.build_dir):
             outfiles = self.copy_tree(self.build_dir, self.install_dir)
         else:
@@ -119,7 +123,7 @@ class install_lib(Command):
             return
         return outfiles
 
-    def byte_compile(self, files):
+    def byte_compile(self, files) -> None:
         if sys.dont_write_bytecode:
             self.warn('byte-compiling is disabled, skipping.')
             return

py2docfx/venv/venv1/Lib/site-packages/setuptools/_distutils/command/install_scripts.py

@@ -8,6 +8,7 @@ Python scripts."""
 import os
 from distutils._log import log
 from stat import ST_MODE
+from typing import ClassVar
 
 from ..core import Command
 
@@ -22,7 +23,7 @@ class install_scripts(Command):
         ('skip-build', None, "skip the build steps"),
     ]
 
-    boolean_options = ['force', 'skip-build']
+    boolean_options: ClassVar[list[str]] = ['force', 'skip-build']
 
     def initialize_options(self):
         self.install_dir = None
@@ -30,7 +31,7 @@ class install_scripts(Command):
         self.build_dir = None
         self.skip_build = None
 
-    def finalize_options(self):
+    def finalize_options(self) -> None:
         self.set_undefined_options('build', ('build_scripts', 'build_dir'))
         self.set_undefined_options(
             'install',
@@ -39,7 +40,7 @@ class install_scripts(Command):
             ('skip_build', 'skip_build'),
         )
 
-    def run(self):
+    def run(self) -> None:
         if not self.skip_build:
             self.run_command('build_scripts')
         self.outfiles = self.copy_tree(self.build_dir, self.install_dir)