pip.download Namespace Reference

Classes
class	MultiDomainBasicAuth
class	LocalFSResponse
class	LocalFSAdapter
class	PipSession

Functions
def	user_agent
def	get_file_content
def	is_url
def	url_to_path
def	path_to_url
def	is_archive_file
def	unpack_vcs_link
def	_get_used_vcs_backend
def	is_vcs_url
def	is_file_url
def	_check_hash
def	_get_hash_from_file
def	_download_url
def	_copy_file
def	unpack_http_url
def	unpack_file_url

Variables
list	__all__
tuple	_scheme_re = re.compile(r'^(http|https|file):', re.I)
tuple	_url_slash_drive_re = re.compile(r'/*([a-z])\|', re.I)
tuple	_drive_re = re.compile('^([a-z]):', re.I)
tuple	_url_drive_re = re.compile('^([a-z])[:|]', re.I)

Function Documentation

def pip.download._check_hash (   download_hash,   link  )

private

def pip.download._copy_file (   filename,   location,   content_type,   link  )

private

def pip.download._download_url (   resp,   link,   temp_location  )

private

def pip.download._get_hash_from_file (   target_file,   link  )

private

def pip.download._get_used_vcs_backend (   link )

private

def pip.download.get_file_content	(		url,
			comes_from = None,
			session = None
	)

Gets the content of a file; it may be a filename, file: URL, or
http: URL.  Returns (location, content).  Content is unicode.

def pip.download.is_archive_file

(

name

)

Return True if `name` is a considered as an archive file.

def pip.download.is_file_url

(

link

)

def pip.download.is_url

(

name

)

Returns true if the name looks like a URL

def pip.download.is_vcs_url

(

link

)

def pip.download.path_to_url

(

path

)

Convert a path to a file: URL.  The path will be made absolute and have
quoted path parts.

def pip.download.unpack_file_url	(		link,
			location,
			download_dir = None
	)

def pip.download.unpack_http_url	(		link,
			location,
			download_cache,
			download_dir = None,
			session = None
	)

def pip.download.unpack_vcs_link	(		link,
			location,
			only_download = False
	)

def pip.download.url_to_path

(

url

)

Convert a file: URL to a path.

def pip.download.user_agent

(

)

Return a string representing the user agent.

Variable Documentation

list pip.download.__all__

Initial value:

= ['get_file_content',
           'is_url', 'url_to_path', 'path_to_url',
           'is_archive_file', 'unpack_vcs_link',
           'unpack_file_url', 'is_vcs_url', 'is_file_url', 'unpack_http_url']

tuple pip.download._drive_re = re.compile('^([a-z]):', re.I)

tuple pip.download._scheme_re = re.compile(r'^(http|https|file):', re.I)

tuple pip.download._url_drive_re = re.compile('^([a-z])[:|]', re.I)

tuple pip.download._url_slash_drive_re = re.compile(r'/*([a-z])\|', re.I)