pytest.skip: Rename "msg" to "reason" for consistency with pytest.mark.skip/xfail?

The signature of pytest.skip is:

skip(msg[, allow_module_level=False])

but the signature of pytest.xfail is:

xfail(reason='')

Marks (pytest.mark.skip, pytest.mark.skipif and pytest.mark.xfail) use reason too:

pytest.mark.skipif(condition, *, reason=None)
pytest.mark.xfail(condition=None, *, reason=None, raises=None, run=True, strict=False)¶
pytest.mark.skipif(condition, *, reason=None)¶

Note that pytest.fail uses msg:

fail(msg='', pytrace=True)

but at least from an user perspective, skip is probably closer to xfail and mark.skip / mark.skipif / mark.xfail.

Should we rename the msg argument for pytest.skip to reason for consistency (with a deprecation for the old name), or isn’t that worth the trouble?

Thanks to Francesco Casalegno for reporting this in the pytest training I gave at Europython 2021 today!

[symonk]

Thanks all, I will carve out some time tonight after work to attempt to unify reason= across the board in places, I have made a start. After I have a few PRs i will look at initially creating follow up PRs to move plugins inside pytest-dev/ using msg= explicitly to use reason= or pass w/o keyword.

[The-Compiler]

Some (naive) code searches:

• pytest.fail(msg=: 15 on grep.app, 128 on Sourcegraph, 7 on Debian Code Search
• pytest.skip(msg=: 45 on grep.app, 112 on Sourcegraph, 9 on Debian Code Search

Positional usage:

• pytest.fail: 1121 on grep.app, 7.3k on Sourcegraph, 767 on Debian Code Search
• pytest.skip: 3700 on grep.app, 25k on Sourcegraph, 2612 on Debian Code Search