Skip to content

Use unicode/bytes literals instead of calls #4309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 5, 2018
Merged

Use unicode/bytes literals instead of calls #4309

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 34 additions & 42 deletions src/_pytest/assertion/util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@
import _pytest._code
from ..compat import Sequence

u = six.text_type

# The _reprcompare attribute on the util module is used by the new assertion
# interpretation code and assertion rewriter to detect this plugin was
# loaded and in turn call the hooks defined here as part of the
Expand All @@ -23,9 +21,9 @@
# the re-encoding is needed for python2 repr
# with non-ascii characters (see issue 877 and 1379)
def ecu(s):
try:
return u(s, "utf-8", "replace")
except TypeError:
if isinstance(s, bytes):
return s.decode("UTF-8", "replace")
else:
return s


Expand All @@ -42,7 +40,7 @@ def format_explanation(explanation):
explanation = ecu(explanation)
lines = _split_explanation(explanation)
result = _format_lines(lines)
return u("\n").join(result)
return u"\n".join(result)


def _split_explanation(explanation):
Expand All @@ -52,7 +50,7 @@ def _split_explanation(explanation):
Any other newlines will be escaped and appear in the line as the
literal '\n' characters.
"""
raw_lines = (explanation or u("")).split("\n")
raw_lines = (explanation or u"").split("\n")
lines = [raw_lines[0]]
for values in raw_lines[1:]:
if values and values[0] in ["{", "}", "~", ">"]:
Expand All @@ -77,13 +75,13 @@ def _format_lines(lines):
for line in lines[1:]:
if line.startswith("{"):
if stackcnt[-1]:
s = u("and ")
s = u"and "
else:
s = u("where ")
s = u"where "
stack.append(len(result))
stackcnt[-1] += 1
stackcnt.append(0)
result.append(u(" +") + u(" ") * (len(stack) - 1) + s + line[1:])
result.append(u" +" + u" " * (len(stack) - 1) + s + line[1:])
elif line.startswith("}"):
stack.pop()
stackcnt.pop()
Expand All @@ -92,7 +90,7 @@ def _format_lines(lines):
assert line[0] in ["~", ">"]
stack[-1] += 1
indent = len(stack) if line.startswith("~") else len(stack) - 1
result.append(u(" ") * indent + line[1:])
result.append(u" " * indent + line[1:])
assert len(stack) == 1
return result

Expand All @@ -110,7 +108,7 @@ def assertrepr_compare(config, op, left, right):
left_repr = py.io.saferepr(left, maxsize=int(width // 2))
right_repr = py.io.saferepr(right, maxsize=width - len(left_repr))

summary = u("%s %s %s") % (ecu(left_repr), op, ecu(right_repr))
summary = u"%s %s %s" % (ecu(left_repr), op, ecu(right_repr))

def issequence(x):
return isinstance(x, Sequence) and not isinstance(x, basestring)
Expand Down Expand Up @@ -155,11 +153,9 @@ def isiterable(obj):
explanation = _notin_text(left, right, verbose)
except Exception:
explanation = [
u(
"(pytest_assertion plugin: representation of details failed. "
"Probably an object has a faulty __repr__.)"
),
u(_pytest._code.ExceptionInfo()),
u"(pytest_assertion plugin: representation of details failed. "
u"Probably an object has a faulty __repr__.)",
six.text_type(_pytest._code.ExceptionInfo()),
]

if not explanation:
Expand Down Expand Up @@ -203,8 +199,7 @@ def escape_for_readable_diff(binary_text):
if i > 42:
i -= 10 # Provide some context
explanation = [
u("Skipping %s identical leading characters in diff, use -v to show")
% i
u"Skipping %s identical leading characters in diff, use -v to show" % i
]
left = left[i:]
right = right[i:]
Expand All @@ -215,11 +210,8 @@ def escape_for_readable_diff(binary_text):
if i > 42:
i -= 10 # Provide some context
explanation += [
u(
"Skipping %s identical trailing "
"characters in diff, use -v to show"
)
% i
u"Skipping {} identical trailing "
u"characters in diff, use -v to show".format(i)
]
left = left[:-i]
right = right[:-i]
Expand All @@ -237,21 +229,21 @@ def escape_for_readable_diff(binary_text):

def _compare_eq_iterable(left, right, verbose=False):
if not verbose:
return [u("Use -v to get the full diff")]
return [u"Use -v to get the full diff"]
# dynamic import to speedup pytest
import difflib

try:
left_formatting = pprint.pformat(left).splitlines()
right_formatting = pprint.pformat(right).splitlines()
explanation = [u("Full diff:")]
explanation = [u"Full diff:"]
except Exception:
# hack: PrettyPrinter.pformat() in python 2 fails when formatting items that can't be sorted(), ie, calling
# sorted() on a list would raise. See issue #718.
# As a workaround, the full diff is generated by using the repr() string of each item of each container.
left_formatting = sorted(repr(x) for x in left)
right_formatting = sorted(repr(x) for x in right)
explanation = [u("Full diff (fallback to calling repr on each item):")]
explanation = [u"Full diff (fallback to calling repr on each item):"]
explanation.extend(
line.strip() for line in difflib.ndiff(left_formatting, right_formatting)
)
Expand All @@ -262,16 +254,16 @@ def _compare_eq_sequence(left, right, verbose=False):
explanation = []
for i in range(min(len(left), len(right))):
if left[i] != right[i]:
explanation += [u("At index %s diff: %r != %r") % (i, left[i], right[i])]
explanation += [u"At index %s diff: %r != %r" % (i, left[i], right[i])]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

at the diff i noted that we should use saferepr here, perhaps a nice followup

break
if len(left) > len(right):
explanation += [
u("Left contains more items, first extra item: %s")
u"Left contains more items, first extra item: %s"
% py.io.saferepr(left[len(right)])
]
elif len(left) < len(right):
explanation += [
u("Right contains more items, first extra item: %s")
u"Right contains more items, first extra item: %s"
% py.io.saferepr(right[len(left)])
]
return explanation
Expand All @@ -282,11 +274,11 @@ def _compare_eq_set(left, right, verbose=False):
diff_left = left - right
diff_right = right - left
if diff_left:
explanation.append(u("Extra items in the left set:"))
explanation.append(u"Extra items in the left set:")
for item in diff_left:
explanation.append(py.io.saferepr(item))
if diff_right:
explanation.append(u("Extra items in the right set:"))
explanation.append(u"Extra items in the right set:")
for item in diff_right:
explanation.append(py.io.saferepr(item))
return explanation
Expand All @@ -297,26 +289,26 @@ def _compare_eq_dict(left, right, verbose=False):
common = set(left).intersection(set(right))
same = {k: left[k] for k in common if left[k] == right[k]}
if same and verbose < 2:
explanation += [u("Omitting %s identical items, use -vv to show") % len(same)]
explanation += [u"Omitting %s identical items, use -vv to show" % len(same)]
elif same:
explanation += [u("Common items:")]
explanation += [u"Common items:"]
explanation += pprint.pformat(same).splitlines()
diff = {k for k in common if left[k] != right[k]}
if diff:
explanation += [u("Differing items:")]
explanation += [u"Differing items:"]
for k in diff:
explanation += [
py.io.saferepr({k: left[k]}) + " != " + py.io.saferepr({k: right[k]})
]
extra_left = set(left) - set(right)
if extra_left:
explanation.append(u("Left contains more items:"))
explanation.append(u"Left contains more items:")
explanation.extend(
pprint.pformat({k: left[k] for k in extra_left}).splitlines()
)
extra_right = set(right) - set(left)
if extra_right:
explanation.append(u("Right contains more items:"))
explanation.append(u"Right contains more items:")
explanation.extend(
pprint.pformat({k: right[k] for k in extra_right}).splitlines()
)
Expand All @@ -329,14 +321,14 @@ def _notin_text(term, text, verbose=False):
tail = text[index + len(term) :]
correct_text = head + tail
diff = _diff_text(correct_text, text, verbose)
newdiff = [u("%s is contained here:") % py.io.saferepr(term, maxsize=42)]
newdiff = [u"%s is contained here:" % py.io.saferepr(term, maxsize=42)]
for line in diff:
if line.startswith(u("Skipping")):
if line.startswith(u"Skipping"):
continue
if line.startswith(u("- ")):
if line.startswith(u"- "):
continue
if line.startswith(u("+ ")):
newdiff.append(u(" ") + line[2:])
if line.startswith(u"+ "):
newdiff.append(u" " + line[2:])
else:
newdiff.append(line)
return newdiff
4 changes: 2 additions & 2 deletions src/_pytest/capture.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@ class FDCaptureBinary(object):
snap() produces `bytes`
"""

EMPTY_BUFFER = bytes()
EMPTY_BUFFER = b""

def __init__(self, targetfd, tmpfile=None):
self.targetfd = targetfd
Expand Down Expand Up @@ -630,7 +630,7 @@ def writeorg(self, data):


class SysCaptureBinary(SysCapture):
EMPTY_BUFFER = bytes()
EMPTY_BUFFER = b""

def snap(self):
res = self.tmpfile.buffer.getvalue()
Expand Down
7 changes: 2 additions & 5 deletions testing/test_assertion.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,11 +539,8 @@ def test_format_nonascii_explanation(self):

def test_mojibake(self):
# issue 429
left = "e"
right = "\xc3\xa9"
if not isinstance(left, bytes):
left = bytes(left, "utf-8")
right = bytes(right, "utf-8")
left = b"e"
right = b"\xc3\xa9"
expl = callequal(left, right)
for line in expl:
assert isinstance(line, six.text_type)
Expand Down