twisted.python._setup
module documentationtwisted.python
View Source
Setuptools convenience functionality.
This file must not import anything from Twisted, as it is loaded by exec
in setup.py
. If you need compatibility functions for this code, duplicate them here.
Variable | notPortedModules | Modules that are not yet ported to Python 3. |
Variable | STATIC_PACKAGE_METADATA | Undocumented |
Class | ConditionalExtension | An extension module that will only be compiled if certain conditions are met. |
Function | getSetupArgs | Generate arguments for setuptools.setup() |
Class | BuildPy3 | A version of build_py that doesn't install the modules that aren't yet ported to Python 3. |
Class | build_ext_twisted | Allow subclasses to easily detect and customize Extensions to build at install-time. |
Variable | _EXTRA_OPTIONS | These are the actual package names and versions that will be used by extras_require . This is not passed to setup directly so that combinations of the packages can be created without the need to copy package names multiple times. |
Variable | _EXTRAS_REQUIRE | extras_require is a dictionary of items that can be passed to setup.py to install optional dependencies. For example, to install the optional dev dependencies one would type:pip install -e ".[dev]" This has been supported by setuptools since 0.5a4. |
Variable | _PLATFORM_INDEPENDENT | A list of all optional cross-platform dependencies, as setuptools version specifiers, used to populate _EXTRAS_REQUIRE . |
Variable | _EXTENSIONS | The list of ConditionalExtension used by the setup process. |
Variable | _PY3 | Undocumented |
Variable | _dev | Undocumented |
Variable | _CONSOLE_SCRIPTS | Undocumented |
Function | _longDescriptionArgsFromReadme | Generate a PyPI long description from the readme. |
Function | _checkCPython | Checks if this implementation is CPython. |
Variable | _isCPython | Undocumented |
extras_require
. This is not passed to setup directly so that combinations of the packages can be created without the need to copy package names multiple times.extras_require
is a dictionary of items that can be passed to setup.py to install optional dependencies. For example, to install the optional dev dependencies one would type:pip install -e ".[dev]"
This has been supported by setuptools since 0.5a4.
_EXTRAS_REQUIRE
.Generate a PyPI long description from the readme.
Parameters | readme | Path to the readme reStructuredText file. (type: str ) |
Returns | Keyword arguments to be passed to setuptools.setup() . (type: str ) |
Generate arguments for setuptools.setup()
Parameters | extensions | C extension modules to maybe build. This argument is to be used for testing. (type: list of ConditionalExtension ) |
readme | Path to the readme reStructuredText file. This argument is to be used for testing. (type: str ) | |
Returns | The keyword arguments to be used by the setup method. (type: dict ) |
Checks if this implementation is CPython.
This uses platform.python_implementation
.
This takes sys
and platform
kwargs that by default use the real modules. You shouldn't care about these -- they are for testing purposes only.
Returns | False if the implementation is definitely not CPython, True otherwise. |