pip._internal.vcs.versioncontrol Namespace Reference

Data Structures
class	RemoteNotFoundError
class	RemoteNotValidError
class	RevOptions
class	VcsSupport
class	VersionControl

Functions
bool	is_url (str name)
str	make_vcs_requirement_url (str repo_url, str rev, str project_name, Optional[str] subdir=None)
Optional[str]	find_path_to_project_root_from_repo_root (str location, str repo_root)

Variables
	logger = logging.getLogger(__name__)
	AuthInfo = Tuple[Optional[str], Optional[str]]
	vcs = VcsSupport()

Detailed Description

Handles all VCS (version control) support

Function Documentation

find_path_to_project_root_from_repo_root()

Optional[str] find_path_to_project_root_from_repo_root	(	str	location,
		str	repo_root
	)

Find the the Python project's root by searching up the filesystem from
`location`. Return the path to project root relative to `repo_root`.
Return None if the project root is `repo_root`, or cannot be found.

Definition at line 85 of file versioncontrol.py.

) -> Optional[str]:
    """
    Find the the Python project's root by searching up the filesystem from
    `location`. Return the path to project root relative to `repo_root`.
    Return None if the project root is `repo_root`, or cannot be found.
    """
    # find project root.
    orig_location = location
    while not is_installable_dir(location):
        last_location = location
        location = os.path.dirname(location)
        if location == last_location:
            # We've traversed up to the root of the filesystem without
            # finding a Python project.
            logger.warning(
                "Could not find a Python project for directory %s (tried all "
                "parent directories)",
                orig_location,
            )
            return None
 
    if os.path.samefile(repo_root, location):
        return None
 
    return os.path.relpath(location, repo_root)
 
 

References i.

is_url()

bool is_url

(

str

name

)

Return true if the name looks like a URL.

Definition at line 57 of file versioncontrol.py.

def is_url(name: str) -> bool:
    """
    Return true if the name looks like a URL.
    """
    scheme = get_url_scheme(name)
    if scheme is None:
        return False
    return scheme in ["http", "https", "file", "ftp"] + vcs.all_schemes
 
 

References i.

make_vcs_requirement_url()

str make_vcs_requirement_url	(	str	repo_url,
		str	rev,
		str	project_name,
		Optional[str]	subdir = None
	)

Return the URL for a VCS requirement.

Args:
  repo_url: the remote VCS url, with any needed VCS prefix (e.g. "git+").
  project_name: the (unescaped) project name.

Definition at line 67 of file versioncontrol.py.

) -> str:
    """
    Return the URL for a VCS requirement.
 
    Args:
      repo_url: the remote VCS url, with any needed VCS prefix (e.g. "git+").
      project_name: the (unescaped) project name.
    """
    egg_project_name = project_name.replace("-", "_")
    req = f"{repo_url}@{rev}#egg={egg_project_name}"
    if subdir:
        req += f"&subdirectory={subdir}"
 
    return req
 
 

References i.

Referenced by VersionControl.get_src_requirement().

Here is the caller graph for this function:

Variable Documentation

AuthInfo

AuthInfo = Tuple[Optional[str], Optional[str]]

Definition at line 54 of file versioncontrol.py.

logger

logger = logging.getLogger(__name__)

Definition at line 52 of file versioncontrol.py.

vcs

vcs = VcsSupport()

Definition at line 271 of file versioncontrol.py.