Skip to content

pytest_make_parametrize_id hook #1535

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

Merged
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
3 changes: 2 additions & 1 deletion CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@
whether to filter the traceback based on the ``ExceptionInfo`` object passed
to it.

*
* New ``pytest_make_parametrize_id`` hook.
Thanks `@palaviv`_ for the PR.

**Changes**

Expand Down
6 changes: 6 additions & 0 deletions _pytest/hookspec.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,12 @@ def pytest_pyfunc_call(pyfuncitem):
def pytest_generate_tests(metafunc):
""" generate (multiple) parametrized calls to a test function."""

@hookspec(firstresult=True)
def pytest_make_parametrize_id(config, val):
"""Return a user-friendly string representation of the given ``val`` that will be used
by @pytest.mark.parametrize calls. Return None if the hook doesn't know about ``val``.
"""

# -------------------------------------------------------------------------
# generic runtest related hooks
# -------------------------------------------------------------------------
Expand Down
20 changes: 14 additions & 6 deletions _pytest/python.py
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,9 @@ def pytest_pycollect_makeitem(collector, name, obj):
res = list(collector._genfunctions(name, obj))
outcome.force_result(res)

def pytest_make_parametrize_id(config, val):
return None

def is_generator(func):
try:
return _pytest._code.getrawcode(func).co_flags & 32 # generator function
Expand Down Expand Up @@ -1030,7 +1033,7 @@ def parametrize(self, argnames, argvalues, indirect=False, ids=None,
if ids and len(ids) != len(argvalues):
raise ValueError('%d tests specified with %d ids' %(
len(argvalues), len(ids)))
ids = idmaker(argnames, argvalues, idfn, ids)
ids = idmaker(argnames, argvalues, idfn, ids, self.config)
newcalls = []
for callspec in self._calls or [CallSpec2(self)]:
for param_index, valset in enumerate(argvalues):
Expand Down Expand Up @@ -1130,7 +1133,7 @@ def _escape_strings(val):
return val.encode('unicode-escape')


def _idval(val, argname, idx, idfn):
def _idval(val, argname, idx, idfn, config=None):
if idfn:
try:
s = idfn(val)
Expand All @@ -1139,6 +1142,11 @@ def _idval(val, argname, idx, idfn):
except Exception:
pass

if config:
hook_id = config.hook.pytest_make_parametrize_id(config=config, val=val)
if hook_id:
return hook_id

if isinstance(val, (bytes, str)) or (_PY2 and isinstance(val, unicode)):
return _escape_strings(val)
elif isinstance(val, (float, int, bool, NoneType)):
Expand All @@ -1151,16 +1159,16 @@ def _idval(val, argname, idx, idfn):
return val.__name__
return str(argname)+str(idx)

def _idvalset(idx, valset, argnames, idfn, ids):
def _idvalset(idx, valset, argnames, idfn, ids, config=None):
if ids is None or ids[idx] is None:
this_id = [_idval(val, argname, idx, idfn)
this_id = [_idval(val, argname, idx, idfn, config)
for val, argname in zip(valset, argnames)]
return "-".join(this_id)
else:
return _escape_strings(ids[idx])

def idmaker(argnames, argvalues, idfn=None, ids=None):
ids = [_idvalset(valindex, valset, argnames, idfn, ids)
def idmaker(argnames, argvalues, idfn=None, ids=None, config=None):
ids = [_idvalset(valindex, valset, argnames, idfn, ids, config)
for valindex, valset in enumerate(argvalues)]
if len(set(ids)) != len(ids):
# The ids are not unique
Expand Down
1 change: 1 addition & 0 deletions doc/en/writing_plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -470,6 +470,7 @@ you can use the following hook:

.. autofunction:: pytest_pycollect_makeitem
.. autofunction:: pytest_generate_tests
.. autofunction:: pytest_make_parametrize_id
Copy link
Member

Choose a reason for hiding this comment

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

👍


After collection is complete, you can modify the order of
items, delete or otherwise amend the test items:
Expand Down
18 changes: 18 additions & 0 deletions testing/python/metafunc.py
Original file line number Diff line number Diff line change
Expand Up @@ -1156,3 +1156,21 @@ def test_limit(limit, myfixture):
""")
reprec = testdir.inline_run()
reprec.assertoutcome(passed=2)

def test_pytest_make_parametrize_id(self, testdir):
testdir.makeconftest("""
def pytest_make_parametrize_id(config, val):
return str(val * 2)
""")
testdir.makepyfile("""
import pytest

@pytest.mark.parametrize("x", range(2))
def test_func(x):
pass
""")
result = testdir.runpytest("-v")
result.stdout.fnmatch_lines([
"*test_func*0*PASS*",
"*test_func*2*PASS*",
])