pytest.param() is not documented

[hynek]

I’ve learned about pytest.param by accident and I’m still not sure what it’s for. It’s used offhand in some examples, but there’s neither any narrative docs nor does it appear in https://docs.pytest.org/en/latest/builtin.html .

Pls fix. :)

[nicoddemus]

Thanks @hynek!

[Jdsleppy]

I'm afraid it doesn't do much and looks to only be a shorthand for another undocumented method:

https://github.com/pytest-dev/pytest/blob/master/_pytest/mark.py#L80

I'm not very familiar with the pytest codebase, but it doesn't seem like it's built for external use.

[The-Compiler]

It is intended for public use, to apply markers in pytest.mark.parametrize or set test IDs easily - i.e. something like pytest.param('foo', marks=pytest.mark.skipif(...)) (instead of the earlier confusing pytest.mark.skipif(...)('foo')), and pytest.param('foo', id='bar') (instead of having the ID in a list disconnected from the parameters).

[rlaverde]

Hi, I just found a little example of it in the documentation (in the second code example of this parametrize section)

Should It be extended? Maybe a new section in the same doc page (parametrize)?

[nicoddemus]

@rlaverde definitely, including a full specification of the parameters would be nice as well.

[dawranliou]

Hi everyone! I'm a new contributor to Pytest. Based on the discussion above I submitted PR #2881 addressing this issue. Could you help me review the PR? Any suggestion is welcome. Thank you!

[nicoddemus]

Closed by #2881