Skip to content
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.

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

Rename _escape_strings to _ascii_escaped #2561

Merged
merged 2 commits into from Jul 10, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions _pytest/compat.py
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ def isclass(object):
STRING_TYPES = bytes, str
UNICODE_TYPES = str,

def _escape_strings(val):
def _ascii_escaped(val):
"""If val is pure ascii, returns it as a str(). Otherwise, escapes
bytes objects into a sequence of escaped bytes:

Expand Down Expand Up @@ -162,7 +162,7 @@ def _escape_strings(val):

from itertools import imap # NOQA

def _escape_strings(val):
def _ascii_escaped(val):
"""In py2 bytes and str are the same type, so return if it's a bytes
object, return it unchanged if it is a full ascii string,
otherwise escape it into its binary form.
Expand Down
10 changes: 5 additions & 5 deletions _pytest/python.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
from _pytest import fixtures
from _pytest import main
from _pytest.compat import (
isclass, isfunction, is_generator, _escape_strings,
isclass, isfunction, is_generator, _ascii_escaped,
REGEX_TYPE, STRING_TYPES, NoneType, NOTSET,
get_real_func, getfslineno, safe_getattr,
safe_str, getlocation, enum,
Expand Down Expand Up @@ -929,7 +929,7 @@ def _idval(val, argname, idx, idfn, config=None):
msg += '\nUpdate your code as this will raise an error in pytest-4.0.'
warnings.warn(msg, DeprecationWarning)
if s:
return _escape_strings(s)
return _ascii_escaped(s)

if config:
hook_id = config.hook.pytest_make_parametrize_id(
Expand All @@ -938,11 +938,11 @@ def _idval(val, argname, idx, idfn, config=None):
return hook_id

if isinstance(val, STRING_TYPES):
return _escape_strings(val)
return _ascii_escaped(val)
elif isinstance(val, (float, int, bool, NoneType)):
return str(val)
elif isinstance(val, REGEX_TYPE):
return _escape_strings(val.pattern)
return _ascii_escaped(val.pattern)
elif enum is not None and isinstance(val, enum.Enum):
return str(val)
elif isclass(val) and hasattr(val, '__name__'):
Expand All @@ -958,7 +958,7 @@ def _idvalset(idx, parameterset, argnames, idfn, ids, config=None):
for val, argname in zip(parameterset.values, argnames)]
return "-".join(this_id)
else:
return _escape_strings(ids[idx])
return _ascii_escaped(ids[idx])


def idmaker(argnames, parametersets, idfn=None, ids=None, config=None):
Expand Down
1 change: 1 addition & 0 deletions changelog/2533.trivial
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Renamed the utility function `_pytest.compat._escape_strings` to `_ascii_escaped` to better communicate the function's purpose.