pip._internal.vcs.versioncontrol Namespace Reference

Classes
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] pip._internal.vcs.versioncontrol.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.

is_url()

bool pip._internal.vcs.versioncontrol.is_url

(

str

name

)

Return true if the name looks like a URL.

make_vcs_requirement_url()

str pip._internal.vcs.versioncontrol.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.