requirementslib.models.setup_info module

class requirementslib.models.setup_info.Analyzer

Bases: ast.NodeVisitor

generic_unparse(item)

generic_visit(node)

Called if no explicit visitor function exists for a node.

match_assignment_name(match)

match_assignment_str(match)

no_recurse()

parse_function_names(should_retry=True, function_map=None)

parse_functions()

parse_setup_function()

unmap_binops()

unparse(item)

unparse_Assign(item)

unparse_Attribute(item)

unparse_BinOp(item)

unparse_Call(item)

unparse_Compare(item)

unparse_Constant(item)

unparse_Dict(item)

unparse_Ellipsis(item)

unparse_IfExp(item)

unparse_List(item)

unparse_Mapping(item)

unparse_Name(item)

unparse_NameConstant(item)

unparse_Num(item)

unparse_Str(item)

unparse_Subscript(item)

unparse_Tuple(item)

unparse_keyword(item)

unparse_list(item)

unparse_str(item)

unparse_tuple(item)

visit_BinOp(node)

class requirementslib.models.setup_info.BaseRequirement(name='', requirement=None)

Bases: object

as_dict()

as_tuple()

classmethod from_req(req)

classmethod from_string(line)

name

requirement

class requirementslib.models.setup_info.BuildEnv(cleanup=True)

Bases: pep517.envbuild.BuildEnvironment

pip_install(reqs)

Install dependencies into this env by calling pip in a subprocess

class requirementslib.models.setup_info.Extra(name=None, requirements: frozenset = NOTHING)

Bases: object

add(req)

as_dict()

name

requirements

class requirementslib.models.setup_info.HookCaller(source_dir, build_backend, backend_path=None)

Bases: pep517.wrappers.Pep517HookCaller

class requirementslib.models.setup_info.ScandirCloser(path)

Bases: object

close()

next()

class requirementslib.models.setup_info.SetupInfo(name=None, base_dir=None, version=None, requirements: frozenset = NOTHING, build_requires=None, build_backend=NOTHING, setup_requires=None, python_requires=None, extras_requirements=None, setup_cfg: pathlib.Path = None, setup_py: pathlib.Path = None, pyproject: pathlib.Path = None, ireq=None, extra_kwargs: dict = NOTHING, metadata=None, stack=None, finalizer=None)

Bases: object

as_dict()

base_dir

build()

build_backend

build_requires

build_sdist()

build_wheel()

classmethod create(base_dir, subdirectory=None, ireq=None, kwargs=None, stack=None)

egg_base

extra_kwargs

extras

classmethod from_ireq(ireq, subdir=None, finder=None, session=None)

classmethod from_requirement(requirement, finder=None)

get_build_backend()

get_egg_metadata(metadata_dir=None, metadata_type=None)

Given a metadata directory, return the corresponding metadata dictionary.

Parameters:

• metadata_dir (Optional[str]) – Root metadata path, default: os.getcwd()
• metadata_type (Optional[str]) – Type of metadata to search for, default None

Returns:

A metadata dictionary built from the metadata in the given location

Return type:

Dict[Any, Any]

get_extras_from_ireq()

get_info()

get_initial_info()

get_metadata_from_wheel(wheel_path)

Given a path to a wheel, return the metadata from that wheel.

Returns:A dictionary of metadata from the provided wheel Return type:Dict[Any, Any]

ireq

metadata

name

parse_setup_cfg()

parse_setup_py()

pep517_config

populate_metadata(metadata)

Populates the metadata dictionary from the supplied metadata.

Returns:The current instance. Return type:SetupInfo

pyproject

python_requires

reload()

Wipe existing distribution info metadata for rebuilding.

Erases metadata from self.egg_base and unsets self.requirements and self.extras.

requires

run_pyproject()

Populates the pyproject.toml metadata if available.

Returns:The current instance Return type:SetupInfo

run_setup()

setup_cfg

setup_py

setup_requires

stack

update_from_dict(metadata)

version

requirementslib.models.setup_info.ast_parse_attribute_from_file(path, attribute)

requirementslib.models.setup_info.ast_parse_file(path)

requirementslib.models.setup_info.ast_parse_setup_py(path)

requirementslib.models.setup_info.ast_unparse(item, initial_mapping=False, analyzer=None, recurse=True)

requirementslib.models.setup_info.build_pep517(source_dir, build_dir, config_settings=None, dist_type='wheel')

requirementslib.models.setup_info.ensure_reqs

requirementslib.models.setup_info.find_distinfo(target, pkg_name=None)

requirementslib.models.setup_info.find_egginfo(target, pkg_name=None)

requirementslib.models.setup_info.get_distinfo_dist(path, pkg_name=None)

requirementslib.models.setup_info.get_egginfo_dist(path, pkg_name=None)

requirementslib.models.setup_info.get_extra_name_from_marker

requirementslib.models.setup_info.get_extras_from_setupcfg(parser)

requirementslib.models.setup_info.get_metadata(path, pkg_name=None, metadata_type=None)

requirementslib.models.setup_info.get_metadata_from_dist(dist)

requirementslib.models.setup_info.get_metadata_from_wheel(wheel_path)

requirementslib.models.setup_info.get_name_and_version_from_setupcfg(parser, package_dir)

requirementslib.models.setup_info.get_package_dir_from_setupcfg(parser, base_dir=None)

requirementslib.models.setup_info.iter_metadata(path, pkg_name=None, metadata_type='egg-info')

requirementslib.models.setup_info.make_base_requirements(reqs)

requirementslib.models.setup_info.parse_setup_cfg(setup_cfg_contents, base_dir)

requirementslib.models.setup_info.parse_special_directives(setup_entry, package_dir=None)

requirementslib.models.setup_info.pep517_subprocess_runner(cmd, cwd=None, extra_environ=None)

The default method of calling the wrapper subprocess.

requirementslib.models.setup_info.run_setup(script_path, egg_base=None)

Run a setup.py script with a target egg_base if provided.

Parameters:

• script_path (S) – The path to the setup.py script to run
• egg_base (Optional[S]) – The metadata directory to build in

Raises:

FileNotFoundError – If the provided script_path does not exist

Returns:

The metadata dictionary

Return type:

Dict[Any, Any]

requirementslib.models.setup_info.setuptools_parse_setup_cfg(path)