pip._vendor.six Namespace Reference

Classes
class	_LazyDescr
class	_LazyModule
class	_MovedItems
class	_SixMetaPathImporter
class	Iterator
class	Module_six_moves_urllib
class	Module_six_moves_urllib_error
class	Module_six_moves_urllib_parse
class	Module_six_moves_urllib_request
class	Module_six_moves_urllib_response
class	Module_six_moves_urllib_robotparser
class	MovedAttribute
class	MovedModule
class	X

Functions
	_add_doc (func, doc)
	_import_module (name)
	add_move (move)
	remove_move (name)
	advance_iterator (it)
	callable (obj)
	get_unbound_function (unbound)
	create_unbound_method (func, cls)
	create_bound_method (func, obj)
	iterkeys (d, **kw)
	itervalues (d, **kw)
	iteritems (d, **kw)
	iterlists (d, **kw)
	b (s)
	u (s)
	byte2int (bs)
	indexbytes (buf, i)
	assertCountEqual (self, *args, **kwargs)
	assertRaisesRegex (self, *args, **kwargs)
	assertRegex (self, *args, **kwargs)
	assertNotRegex (self, *args, **kwargs)
	reraise (tp, value, tb=None)
	exec_ (_code_, _globs_=None, _locs_=None)
	raise_from (value, from_value)
	print_ (*args, **kwargs)
	_update_wrapper (wrapper, wrapped, assigned=functools.WRAPPER_ASSIGNMENTS, updated=functools.WRAPPER_UPDATES)
	wraps (wrapped, assigned=functools.WRAPPER_ASSIGNMENTS, updated=functools.WRAPPER_UPDATES)
	with_metaclass (meta, *bases)
	add_metaclass (metaclass)
	ensure_binary (s, encoding='utf-8', errors='strict')
	ensure_str (s, encoding='utf-8', errors='strict')
	ensure_text (s, encoding='utf-8', errors='strict')
	python_2_unicode_compatible (klass)

Variables
int	PY2 = 2
int	PY3 = 3
tuple	PY34 = (3, 4)
	string_types = str,
	integer_types = int,
	class_types = type,
	text_type = str
	binary_type = bytes
	MAXSIZE = sys.maxsize
	spec_from_loader = None
	_importer = _SixMetaPathImporter(__name__)
list	_moved_attributes
	moves = _MovedItems(__name__ + ".moves")
list	_urllib_parse_moved_attributes
list	_urllib_error_moved_attributes
list	_urllib_request_moved_attributes
list	_urllib_response_moved_attributes
list	_urllib_robotparser_moved_attributes
str	_meth_func = "__func__"
str	_meth_self = "__self__"
str	_func_closure = "__closure__"
str	_func_code = "__code__"
str	_func_defaults = "__defaults__"
str	_func_globals = "__globals__"
	advance_iterator = next
	next = advance_iterator
	callable = callable
	create_bound_method = types.MethodType
	Iterator = object
	get_method_function = operator.attrgetter(_meth_func)
	get_method_self = operator.attrgetter(_meth_self)
	get_function_closure = operator.attrgetter(_func_closure)
	get_function_code = operator.attrgetter(_func_code)
	get_function_defaults = operator.attrgetter(_func_defaults)
	get_function_globals = operator.attrgetter(_func_globals)
	viewkeys = operator.methodcaller("keys")
	viewvalues = operator.methodcaller("values")
	viewitems = operator.methodcaller("items")
	unichr = chr
	int2byte = struct.Struct(">B").pack
	byte2int = operator.itemgetter(0)
	indexbytes = operator.getitem
	iterbytes = iter
	StringIO = io.StringIO
	BytesIO = io.BytesIO
str	_assertCountEqual = "assertCountEqual"
str	_assertRaisesRegex = "assertRaisesRegexp"
str	_assertRegex = "assertRegexpMatches"
str	_assertNotRegex = "assertNotRegexpMatches"
	exec_ = getattr(moves.builtins, "exec")
	print_ = getattr(moves.builtins, "print", None)
	_print = print_
	wraps = functools.wraps
	submodule_search_locations

Detailed Description

Utilities for writing code that runs on Python 2 and 3

Function Documentation

_add_doc()

pip._vendor.six._add_doc (   func,   doc  )

protected

Add documentation to a function.

_import_module()

pip._vendor.six._import_module (   name )

protected

Import module, returning the module after the last dot.

add_metaclass()

pip._vendor.six.add_metaclass

(

metaclass

)

Class decorator for creating a class with a metaclass.

add_move()

pip._vendor.six.add_move

(

move

)

Add an item to six.moves.

ensure_binary()

pip._vendor.six.ensure_binary	(		s,
			encoding = 'utf-8',
			errors = 'strict'
	)

Coerce **s** to six.binary_type.

For Python 2:
  - `unicode` -> encoded to `str`
  - `str` -> `str`

For Python 3:
  - `str` -> encoded to `bytes`
  - `bytes` -> `bytes`

ensure_str()

pip._vendor.six.ensure_str	(		s,
			encoding = 'utf-8',
			errors = 'strict'
	)

Coerce *s* to `str`.

For Python 2:
  - `unicode` -> encoded to `str`
  - `str` -> `str`

For Python 3:
  - `str` -> `str`
  - `bytes` -> decoded to `str`

ensure_text()

pip._vendor.six.ensure_text	(		s,
			encoding = 'utf-8',
			errors = 'strict'
	)

Coerce *s* to six.text_type.

For Python 2:
  - `unicode` -> `unicode`
  - `str` -> `unicode`

For Python 3:
  - `str` -> `str`
  - `bytes` -> decoded to `str`

exec_()

pip._vendor.six.exec_	(		_code_,
			_globs_ = None,
			_locs_ = None
	)

Execute code in a namespace.

print_()

pip._vendor.six.print_	(	*	args,
		**	kwargs
	)

The new-style print function for Python 2.4 and 2.5.

python_2_unicode_compatible()

pip._vendor.six.python_2_unicode_compatible

(

klass

)

A class decorator that defines __unicode__ and __str__ methods under Python 2.
Under Python 3 it does nothing.

To support Python 2 and 3 with a single code base, define a __str__ method
returning text and apply this decorator to the class.

remove_move()

pip._vendor.six.remove_move

(

name

)

Remove item from six.moves.

with_metaclass()

pip._vendor.six.with_metaclass	(		meta,
		*	bases
	)

Create a base class with a metaclass.

Variable Documentation

_urllib_error_moved_attributes

list pip._vendor.six._urllib_error_moved_attributes

protected

Initial value:

=  [
    MovedAttribute("URLError", "urllib2", "urllib.error"),
    MovedAttribute("HTTPError", "urllib2", "urllib.error"),
    MovedAttribute("ContentTooShortError", "urllib", "urllib.error"),
]

_urllib_parse_moved_attributes

list pip._vendor.six._urllib_parse_moved_attributes

protected

Initial value:

=  [
    MovedAttribute("ParseResult", "urlparse", "urllib.parse"),
    MovedAttribute("SplitResult", "urlparse", "urllib.parse"),
    MovedAttribute("parse_qs", "urlparse", "urllib.parse"),
    MovedAttribute("parse_qsl", "urlparse", "urllib.parse"),
    MovedAttribute("urldefrag", "urlparse", "urllib.parse"),
    MovedAttribute("urljoin", "urlparse", "urllib.parse"),
    MovedAttribute("urlparse", "urlparse", "urllib.parse"),
    MovedAttribute("urlsplit", "urlparse", "urllib.parse"),
    MovedAttribute("urlunparse", "urlparse", "urllib.parse"),
    MovedAttribute("urlunsplit", "urlparse", "urllib.parse"),
    MovedAttribute("quote", "urllib", "urllib.parse"),
    MovedAttribute("quote_plus", "urllib", "urllib.parse"),
    MovedAttribute("unquote", "urllib", "urllib.parse"),
    MovedAttribute("unquote_plus", "urllib", "urllib.parse"),
    MovedAttribute("unquote_to_bytes", "urllib", "urllib.parse", "unquote", "unquote_to_bytes"),
    MovedAttribute("urlencode", "urllib", "urllib.parse"),
    MovedAttribute("splitquery", "urllib", "urllib.parse"),
    MovedAttribute("splittag", "urllib", "urllib.parse"),
    MovedAttribute("splituser", "urllib", "urllib.parse"),
    MovedAttribute("splitvalue", "urllib", "urllib.parse"),
    MovedAttribute("uses_fragment", "urlparse", "urllib.parse"),
    MovedAttribute("uses_netloc", "urlparse", "urllib.parse"),
    MovedAttribute("uses_params", "urlparse", "urllib.parse"),
    MovedAttribute("uses_query", "urlparse", "urllib.parse"),
    MovedAttribute("uses_relative", "urlparse", "urllib.parse"),
]

_urllib_response_moved_attributes

list pip._vendor.six._urllib_response_moved_attributes

protected

Initial value:

=  [
    MovedAttribute("addbase", "urllib", "urllib.response"),
    MovedAttribute("addclosehook", "urllib", "urllib.response"),
    MovedAttribute("addinfo", "urllib", "urllib.response"),
    MovedAttribute("addinfourl", "urllib", "urllib.response"),
]

_urllib_robotparser_moved_attributes

list pip._vendor.six._urllib_robotparser_moved_attributes

protected

Initial value:

=  [
    MovedAttribute("RobotFileParser", "robotparser", "urllib.robotparser"),
]