pip.vcs.git.Git Class Reference

Inheritance diagram for pip.vcs.git.Git:

Public Member Functions
def	__init__
def	parse_vcs_bundle_file
def	export
def	check_rev_options
def	switch
def	update
def	obtain
def	get_url
def	get_revision
def	get_refs
def	get_src_requirement
def	get_url_rev
def	update_submodules
Public Member Functions inherited from pip.vcs.VersionControl
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
Public Attributes inherited from pip.vcs.VersionControl
	url

Static Public Attributes
string	name = 'git'
string	dirname = '.git'
string	repo_name = 'clone'
tuple	schemes = ('git', 'git+http', 'git+https', 'git+ssh', 'git+git', 'git+file')
string	bundle_file = 'git-clone.txt'
tuple	guide
Static Public Attributes inherited from pip.vcs.VersionControl
string	name = ''
string	dirname = ''

Constructor & Destructor Documentation

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

Member Function Documentation

def pip.vcs.git.Git.check_rev_options	(		self,
			rev,
			dest,
			rev_options
	)

Check the revision options before checkout to compensate that tags
and branches may need origin/ as a prefix.
Returns the SHA1 of the branch or tag if found.

def pip.vcs.git.Git.export	(		self,
			location
	)

Export the Git repository at the url to the destination location

def pip.vcs.git.Git.get_refs	(		self,
			location
	)

Return map of named refs (branches or tags) to commit hashes.

def pip.vcs.git.Git.get_revision	(		self,
			location
	)

def pip.vcs.git.Git.get_src_requirement	(		self,
			dist,
			location,
			find_tags
	)

def pip.vcs.git.Git.get_url	(		self,
			location
	)

def pip.vcs.git.Git.get_url_rev

(

self

)

Prefixes stub URLs like 'user@hostname:user/repo.git' with 'ssh://'.
That's required because although they use SSH they sometimes doesn't
work with a ssh:// scheme (e.g. Github). But we need a scheme for
parsing. Hence we remove it again afterwards and return it as a stub.

def pip.vcs.git.Git.obtain	(		self,
			dest
	)

def pip.vcs.git.Git.parse_vcs_bundle_file	(		self,
			content
	)

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

def pip.vcs.git.Git.update	(		self,
			dest,
			rev_options
	)

def pip.vcs.git.Git.update_submodules	(		self,
			location
	)

Member Data Documentation

string pip.vcs.git.Git.bundle_file = 'git-clone.txt'

static

string pip.vcs.git.Git.dirname = '.git'

static

tuple pip.vcs.git.Git.guide

static

Initial value:

= ('# This was a Git repo; to make it a repo again run:\n'
        'git init\ngit remote add origin %(url)s -f\ngit checkout %(rev)s\n')

string pip.vcs.git.Git.name = 'git'

static

string pip.vcs.git.Git.repo_name = 'clone'

static

tuple pip.vcs.git.Git.schemes = ('git', 'git+http', 'git+https', 'git+ssh', 'git+git', 'git+file')

static

pip.vcs.git.Git.url

---

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

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