pip._internal.req Namespace Reference

Namespaces
namespace	constructors
namespace	req_file
namespace	req_install
namespace	req_set
namespace	req_uninstall

Data Structures
class	InstallationResult

Functions
Generator[Tuple[str, InstallRequirement], None, None]	_validate_requirements (List[InstallRequirement] requirements)
List[InstallationResult]	install_given_reqs (List[InstallRequirement] requirements, Sequence[str] global_options, Optional[str] root, Optional[str] home, Optional[str] prefix, bool warn_script_location, bool use_user_site, bool pycompile)

Variables
	logger = logging.getLogger(__name__)

Function Documentation

_validate_requirements()

Generator[Tuple[str, InstallRequirement], None, None] _validate_requirements ( List[InstallRequirement]  requirements )

protected

Definition at line 29 of file __init__.py.

) -> Generator[Tuple[str, InstallRequirement], None, None]:
    for req in requirements:
        assert req.name, f"invalid to-be-installed requirement: {req}"
        yield req.name, req
 
 

References i.

Referenced by pip._internal.req.install_given_reqs().

Here is the caller graph for this function:

install_given_reqs()

List[InstallationResult] install_given_reqs	(	List[InstallRequirement]	requirements,
		Sequence[str]	global_options,
		Optional[str]	root,
		Optional[str]	home,
		Optional[str]	prefix,
		bool	warn_script_location,
		bool	use_user_site,
		bool	pycompile
	)

Install everything in the given list.

(to be called after having downloaded and unpacked the packages)

Definition at line 37 of file __init__.py.

) -> List[InstallationResult]:
    """
    Install everything in the given list.
 
    (to be called after having downloaded and unpacked the packages)
    """
    to_install = collections.OrderedDict(_validate_requirements(requirements))
 
    if to_install:
        logger.info(
            "Installing collected packages: %s",
            ", ".join(to_install.keys()),
        )
 
    installed = []
 
    with indent_log():
        for req_name, requirement in to_install.items():
            if requirement.should_reinstall:
                logger.info("Attempting uninstall: %s", req_name)
                with indent_log():
                    uninstalled_pathset = requirement.uninstall(auto_confirm=True)
            else:
                uninstalled_pathset = None
 
            try:
                requirement.install(
                    global_options,
                    root=root,
                    home=home,
                    prefix=prefix,
                    warn_script_location=warn_script_location,
                    use_user_site=use_user_site,
                    pycompile=pycompile,
                )
            except Exception:
                # if install did not succeed, rollback previous uninstall
                if uninstalled_pathset and not requirement.install_succeeded:
                    uninstalled_pathset.rollback()
                raise
            else:
                if uninstalled_pathset and requirement.install_succeeded:
                    uninstalled_pathset.commit()
 
            installed.append(InstallationResult(req_name))
 
    return installed

References pip._internal.req._validate_requirements(), and i.

Here is the call graph for this function:

Variable Documentation

logger

logger = logging.getLogger(__name__)

Definition at line 18 of file __init__.py.