py3compat.py
239 lines
| 7.2 KiB
| text/x-python
|
PythonLexer
Thomas Kluyver
|
r4740 | # coding: utf-8 | ||
"""Compatibility tricks for Python 3. Mainly to do with unicode.""" | ||||
Thomas Kluyver
|
r4894 | import functools | ||
Thomas Kluyver
|
r4730 | import sys | ||
Thomas Kluyver
|
r4890 | import re | ||
Thomas Kluyver
|
r4759 | import types | ||
Brandon Parsons
|
r6655 | |||
Brandon Parsons
|
r6716 | from .encoding import DEFAULT_ENCODING | ||
Thomas Kluyver
|
r4730 | |||
Thomas Kluyver
|
r4743 | orig_open = open | ||
Thomas Kluyver
|
r4730 | def no_code(x, encoding=None): | ||
return x | ||||
def decode(s, encoding=None): | ||||
Brandon Parsons
|
r6716 | encoding = encoding or DEFAULT_ENCODING | ||
Thomas Kluyver
|
r4730 | return s.decode(encoding, "replace") | ||
def encode(u, encoding=None): | ||||
Brandon Parsons
|
r6716 | encoding = encoding or DEFAULT_ENCODING | ||
Thomas Kluyver
|
r4730 | return u.encode(encoding, "replace") | ||
Brandon Parsons
|
r6651 | |||
Thomas Kluyver
|
r4731 | def cast_unicode(s, encoding=None): | ||
if isinstance(s, bytes): | ||||
return decode(s, encoding) | ||||
return s | ||||
def cast_bytes(s, encoding=None): | ||||
if not isinstance(s, bytes): | ||||
return encode(s, encoding) | ||||
return s | ||||
Thomas Kluyver
|
r4730 | |||
Thomas Kluyver
|
r4894 | def _modify_str_or_docstring(str_change_func): | ||
@functools.wraps(str_change_func) | ||||
def wrapper(func_or_str): | ||||
Thomas Kluyver
|
r13353 | if isinstance(func_or_str, string_types): | ||
Thomas Kluyver
|
r4894 | func = None | ||
doc = func_or_str | ||||
else: | ||||
func = func_or_str | ||||
doc = func.__doc__ | ||||
doc = str_change_func(doc) | ||||
if func: | ||||
func.__doc__ = doc | ||||
return func | ||||
return doc | ||||
return wrapper | ||||
MinRK
|
r10635 | def safe_unicode(e): | ||
"""unicode(e) with various fallbacks. Used for exceptions, which may not be | ||||
safe to call unicode() on. | ||||
""" | ||||
try: | ||||
Thomas Kluyver
|
r13353 | return unicode_type(e) | ||
MinRK
|
r10635 | except UnicodeError: | ||
pass | ||||
try: | ||||
rossant
|
r12327 | return str_to_unicode(str(e)) | ||
MinRK
|
r10635 | except UnicodeError: | ||
pass | ||||
try: | ||||
rossant
|
r12327 | return str_to_unicode(repr(e)) | ||
MinRK
|
r10635 | except UnicodeError: | ||
pass | ||||
return u'Unrecoverably corrupt evalue' | ||||
Thomas Kluyver
|
r4730 | if sys.version_info[0] >= 3: | ||
PY3 = True | ||||
input = input | ||||
builtin_mod_name = "builtins" | ||||
Thomas Kluyver
|
r13351 | import builtins as builtin_mod | ||
Thomas Kluyver
|
r4730 | |||
str_to_unicode = no_code | ||||
unicode_to_str = no_code | ||||
str_to_bytes = encode | ||||
bytes_to_str = decode | ||||
Thomas Kluyver
|
r4758 | cast_bytes_py2 = no_code | ||
Thomas Kluyver
|
r4730 | |||
Thomas Kluyver
|
r9197 | string_types = (str,) | ||
Thomas Kluyver
|
r13153 | unicode_type = str | ||
Thomas Kluyver
|
r9197 | |||
Thomas Kluyver
|
r4740 | def isidentifier(s, dotted=False): | ||
if dotted: | ||||
return all(isidentifier(a) for a in s.split(".")) | ||||
return s.isidentifier() | ||||
Thomas Kluyver
|
r4743 | |||
open = orig_open | ||||
Thomas Kluyver
|
r13356 | xrange = range | ||
Thomas Kluyver
|
r13361 | iteritems = dict.items | ||
itervalues = dict.values | ||||
Thomas Kluyver
|
r4759 | |||
MethodType = types.MethodType | ||||
MinRK
|
r4780 | |||
def execfile(fname, glob, loc=None): | ||||
loc = loc if (loc is not None) else glob | ||||
Bradley M. Froehle
|
r7803 | with open(fname, 'rb') as f: | ||
Thomas Kluyver
|
r13350 | exec(compile(f.read(), fname, 'exec'), glob, loc) | ||
Thomas Kluyver
|
r4890 | |||
# Refactor print statements in doctests. | ||||
_print_statement_re = re.compile(r"\bprint (?P<expr>.*)$", re.MULTILINE) | ||||
def _print_statement_sub(match): | ||||
expr = match.groups('expr') | ||||
return "print(%s)" % expr | ||||
Thomas Kluyver
|
r4894 | |||
@_modify_str_or_docstring | ||||
def doctest_refactor_print(doc): | ||||
Thomas Kluyver
|
r4890 | """Refactor 'print x' statements in a doctest to print(x) style. 2to3 | ||
unfortunately doesn't pick up on our doctests. | ||||
Can accept a string or a function, so it can be used as a decorator.""" | ||||
Thomas Kluyver
|
r4894 | return _print_statement_re.sub(_print_statement_sub, doc) | ||
# Abstract u'abc' syntax: | ||||
@_modify_str_or_docstring | ||||
def u_format(s): | ||||
""""{u}'abc'" --> "'abc'" (Python 3) | ||||
Thomas Kluyver
|
r4890 | |||
Thomas Kluyver
|
r4894 | Accepts a string or a function, so it can be used as a decorator.""" | ||
return s.format(u='') | ||||
Thomas Kluyver
|
r4740 | |||
Thomas Kluyver
|
r4730 | else: | ||
PY3 = False | ||||
input = raw_input | ||||
builtin_mod_name = "__builtin__" | ||||
Thomas Kluyver
|
r13351 | import __builtin__ as builtin_mod | ||
Thomas Kluyver
|
r4730 | |||
str_to_unicode = decode | ||||
unicode_to_str = encode | ||||
str_to_bytes = no_code | ||||
bytes_to_str = no_code | ||||
Thomas Kluyver
|
r4758 | cast_bytes_py2 = cast_bytes | ||
Thomas Kluyver
|
r4740 | |||
Thomas Kluyver
|
r9197 | string_types = (str, unicode) | ||
Thomas Kluyver
|
r13153 | unicode_type = unicode | ||
Thomas Kluyver
|
r9197 | |||
Thomas Kluyver
|
r4740 | import re | ||
_name_re = re.compile(r"[a-zA-Z_][a-zA-Z0-9_]*$") | ||||
def isidentifier(s, dotted=False): | ||||
if dotted: | ||||
return all(isidentifier(a) for a in s.split(".")) | ||||
return bool(_name_re.match(s)) | ||||
Thomas Kluyver
|
r4743 | |||
class open(object): | ||||
"""Wrapper providing key part of Python 3 open() interface.""" | ||||
def __init__(self, fname, mode="r", encoding="utf-8"): | ||||
self.f = orig_open(fname, mode) | ||||
self.enc = encoding | ||||
def write(self, s): | ||||
return self.f.write(s.encode(self.enc)) | ||||
def read(self, size=-1): | ||||
return self.f.read(size).decode(self.enc) | ||||
def close(self): | ||||
return self.f.close() | ||||
def __enter__(self): | ||||
return self | ||||
def __exit__(self, etype, value, traceback): | ||||
self.f.close() | ||||
Thomas Kluyver
|
r4759 | |||
Thomas Kluyver
|
r13356 | xrange = xrange | ||
Thomas Kluyver
|
r13361 | iteritems = dict.iteritems | ||
itervalues = dict.itervalues | ||||
Thomas Kluyver
|
r13356 | |||
Thomas Kluyver
|
r4759 | def MethodType(func, instance): | ||
return types.MethodType(func, instance, type(instance)) | ||||
MinRK
|
r4780 | |||
# don't override system execfile on 2.x: | ||||
execfile = execfile | ||||
Thomas Kluyver
|
r4890 | |||
def doctest_refactor_print(func_or_str): | ||||
return func_or_str | ||||
Thomas Kluyver
|
r4730 | |||
Jörgen Stenarson
|
r5089 | |||
Thomas Kluyver
|
r4894 | # Abstract u'abc' syntax: | ||
@_modify_str_or_docstring | ||||
def u_format(s): | ||||
""""{u}'abc'" --> "u'abc'" (Python 2) | ||||
Accepts a string or a function, so it can be used as a decorator.""" | ||||
return s.format(u='u') | ||||
Jörgen Stenarson
|
r5089 | |||
Jörgen Stenarson
|
r5090 | if sys.platform == 'win32': | ||
Jörgen Stenarson
|
r5094 | def execfile(fname, glob=None, loc=None): | ||
Jörgen Stenarson
|
r5090 | loc = loc if (loc is not None) else glob | ||
Fernando Perez
|
r5380 | # The rstrip() is necessary b/c trailing whitespace in files will | ||
# cause an IndentationError in Python 2.6 (this was fixed in 2.7, | ||||
# but we still support 2.6). See issue 1027. | ||||
Thomas Kluyver
|
r13351 | scripttext = builtin_mod.open(fname).read().rstrip() + '\n' | ||
Thomas Kluyver
|
r5133 | # compile converts unicode filename to str assuming | ||
# ascii. Let's do the conversion before calling compile | ||||
Jörgen Stenarson
|
r5090 | if isinstance(fname, unicode): | ||
filename = unicode_to_str(fname) | ||||
else: | ||||
filename = fname | ||||
Thomas Kluyver
|
r13350 | exec(compile(scripttext, filename, 'exec'), glob, loc) | ||
Jörgen Stenarson
|
r5090 | else: | ||
Thomas Kluyver
|
r5133 | def execfile(fname, *where): | ||
Jörgen Stenarson
|
r5090 | if isinstance(fname, unicode): | ||
filename = fname.encode(sys.getfilesystemencoding()) | ||||
else: | ||||
filename = fname | ||||
Thomas Kluyver
|
r13351 | builtin_mod.execfile(filename, *where) | ||
Thomas Kluyver
|
r13359 | |||
# Parts below taken from six: | ||||
# Copyright (c) 2010-2013 Benjamin Peterson | ||||
# | ||||
# Permission is hereby granted, free of charge, to any person obtaining a copy | ||||
# of this software and associated documentation files (the "Software"), to deal | ||||
# in the Software without restriction, including without limitation the rights | ||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||||
# copies of the Software, and to permit persons to whom the Software is | ||||
# furnished to do so, subject to the following conditions: | ||||
# | ||||
# The above copyright notice and this permission notice shall be included in all | ||||
# copies or substantial portions of the Software. | ||||
# | ||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||||
# SOFTWARE. | ||||
def with_metaclass(meta, *bases): | ||||
"""Create a base class with a metaclass.""" | ||||
return meta("NewBase", bases, {}) | ||||