pip.vcs.VersionControl Class Reference

Inheritance diagram for pip.vcs.VersionControl:

Public Member Functions
def	__init__
def	cmd
def	get_url_rev
def	get_info
def	normalize_url
def	compare_urls
def	parse_vcs_bundle_file
def	obtain
def	switch
def	update
def	check_destination
def	unpack
def	get_src_requirement

Public Attributes
	url

Static Public Attributes
string	name = ''
string	dirname = ''

Private Member Functions
def	_filter
def	_is_local_repository

Private Attributes
	_cmd

Constructor & Destructor Documentation

def pip.vcs.VersionControl.__init__	(		self,
			url = None,
			args,
			kwargs
	)

Member Function Documentation

def pip.vcs.VersionControl._filter (   self,   line  )

private

def pip.vcs.VersionControl._is_local_repository (   self,   repo  )

private

   posix absolute paths start with os.path.sep,
   win32 ones ones start with drive (like c:\\folder)

def pip.vcs.VersionControl.check_destination	(		self,
			dest,
			url,
			rev_options,
			rev_display
	)

Prepare a location to receive a checkout/clone.

Return True if the location is ready for (and requires) a
checkout/clone, False otherwise.

def pip.vcs.VersionControl.cmd

(

self

)

def pip.vcs.VersionControl.compare_urls	(		self,
			url1,
			url2
	)

Compare two repo URLs for identity, ignoring incidental differences.

def pip.vcs.VersionControl.get_info	(		self,
			location
	)

Returns (url, revision), where both are strings

def pip.vcs.VersionControl.get_src_requirement	(		self,
			dist,
			location,
			find_tags = False
	)

def pip.vcs.VersionControl.get_url_rev

(

self

)

Returns the correct repository URL and revision by parsing the given
repository URL

def pip.vcs.VersionControl.normalize_url	(		self,
			url
	)

Normalize a URL for comparison by unquoting it and removing any trailing slash.

def pip.vcs.VersionControl.obtain	(		self,
			dest
	)

Called when installing or updating an editable package, takes the
source path of the checkout.

def pip.vcs.VersionControl.parse_vcs_bundle_file	(		self,
			content
	)

Takes the contents of the bundled text file that explains how to revert
the stripped off version control data of the given package and returns
the URL and revision of it.

def pip.vcs.VersionControl.switch	(		self,
			dest,
			url,
			rev_options
	)

Switch the repo at ``dest`` to point to ``URL``.

def pip.vcs.VersionControl.unpack	(		self,
			location
	)

def pip.vcs.VersionControl.update	(		self,
			dest,
			rev_options
	)

Update an already-existing repo to the given ``rev_options``.

Member Data Documentation

pip.vcs.VersionControl._cmd

private

string pip.vcs.VersionControl.dirname = ''

static

string pip.vcs.VersionControl.name = ''

static

pip.vcs.VersionControl.url

---

The documentation for this class was generated from the following file:

• orbits/lib/python2.7/site-packages/pip/vcs/__init__.py