pip._vendor.distlib.compat Namespace Reference

Classes
class	CertificateError
class	Container
class	ZipExtFile
class	ZipFile
class	ChainMap
class	OrderedDict
class	ConvertingDict
class	ConvertingList
class	ConvertingTuple
class	BaseConfigurator

Functions
def	quote
def	splituser
def	_dnsname_to_pat
def	match_hostname
def	which
def	python_implementation
def	callable
def	fsencode
def	fsdecode
def	_get_normal_name
def	detect_encoding
def	_recursive_repr
def	cache_from_source
def	valid_ident
def	pop

Variables
	string_types = basestring,
	text_type = unicode
	raw_input = raw_input
	_userprog = None
	filter = filter
	ZipFile = BaseZipFile
	callable = callable
	fsencode = os.fsencode
	fsdecode = os.fsdecode
tuple	_fsencoding = sys.getfilesystemencoding()
string	_fserrors = 'strict'
tuple	cookie_re = re.compile("coding[:=]\s*([-\w.]+)")
tuple	unescape = HTMLParser()
tuple	IDENTIFIER = re.compile('^[a-z_][a-z0-9_]*$', re.I)

Function Documentation

def pip._vendor.distlib.compat._dnsname_to_pat (   dn )

private

def pip._vendor.distlib.compat._get_normal_name (   orig_enc )

private

Imitates get_normal_name in tokenizer.c.

def pip._vendor.distlib.compat._recursive_repr (   fillvalue = '...' )

private

Decorator to make a repr function return fillvalue for a recursive
call

def pip._vendor.distlib.compat.cache_from_source	(		path,
			debug_override = None
	)

def pip._vendor.distlib.compat.callable

(

obj

)

def pip._vendor.distlib.compat.detect_encoding

(

readline

)

The detect_encoding() function is used to detect the encoding that should
be used to decode a Python source file.  It requires one argment, readline,
in the same way as the tokenize() generator.

It will call readline a maximum of twice, and return the encoding used
(as a string) and a list of any lines (left as bytes) it has read in.

It detects the encoding from the presence of a utf-8 bom or an encoding
cookie as specified in pep-0263.  If both a bom and a cookie are present,
but disagree, a SyntaxError will be raised.  If the encoding cookie is an
invalid charset, raise a SyntaxError.  Note that if a utf-8 bom is found,
'utf-8-sig' is returned.

If no encoding is specified, then the default of 'utf-8' will be returned.

def pip._vendor.distlib.compat.fsdecode

(

filename

)

def pip._vendor.distlib.compat.fsencode

(

filename

)

def pip._vendor.distlib.compat.match_hostname	(		cert,
			hostname
	)

Verify that *cert* (in decoded format as returned by
SSLSocket.getpeercert()) matches the *hostname*.  RFC 2818 rules
are mostly followed, but IP addresses are not accepted for *hostname*.

CertificateError is raised on failure. On success, the function
returns nothing.

def pip._vendor.distlib.compat.pop	(		self,
			key,
			default = None
	)

def pip._vendor.distlib.compat.python_implementation

(

)

Return a string identifying the Python implementation.

def pip._vendor.distlib.compat.quote

(

s

)

def pip._vendor.distlib.compat.splituser

(

host

)

splituser('user[:passwd]@host[:port]') --> 'user[:passwd]', 'host[:port]'.

def pip._vendor.distlib.compat.valid_ident

(

s

)

def pip._vendor.distlib.compat.which	(		cmd,
			mode = os.F_OK | os.X_OK,
			path = None
	)

Given a command, mode, and a PATH string, return the path which
conforms to the given mode on the PATH, or None if there is no such
file.

`mode` defaults to os.F_OK | os.X_OK. `path` defaults to the result
of os.environ.get("PATH"), or can be overridden with a custom search
path.

Variable Documentation

tuple pip._vendor.distlib.compat._fsencoding = sys.getfilesystemencoding()

string pip._vendor.distlib.compat._fserrors = 'strict'

pip._vendor.distlib.compat._userprog = None

pip._vendor.distlib.compat.callable = callable

tuple pip._vendor.distlib.compat.cookie_re = re.compile("coding[:=]\s*([-\w.]+)")

pip._vendor.distlib.compat.filter = filter

pip._vendor.distlib.compat.fsdecode = os.fsdecode

pip._vendor.distlib.compat.fsencode = os.fsencode

tuple pip._vendor.distlib.compat.IDENTIFIER = re.compile('^[a-z_][a-z0-9_]*$', re.I)

pip._vendor.distlib.compat.raw_input = raw_input

pip._vendor.distlib.compat.string_types = basestring,

pip._vendor.distlib.compat.text_type = unicode

tuple pip._vendor.distlib.compat.unescape = HTMLParser()

pip._vendor.distlib.compat.ZipFile = BaseZipFile