Skip to content

[docs] add naming convention defaults for nose and pytest #8502

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 2 commits into from
Jul 6, 2023
Merged

[docs] add naming convention defaults for nose and pytest #8502

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ddd773e
[docs] add table nose x pytest naming comparison
mickeypash Mar 31, 2021
b81003f
Incorporate legend into main table
Zac-HD Jul 6, 2023
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
25 changes: 21 additions & 4 deletions doc/en/how-to/nose.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,7 @@ Unsupported idioms / known issues
- nose imports test modules with the same import path (e.g.
``tests.test_mode``) but different file system paths
(e.g. ``tests/test_mode.py`` and ``other/tests/test_mode.py``)
by extending sys.path/import semantics. pytest does not do that
but there is discussion in :issue:`268` for adding some support. Note that
by extending sys.path/import semantics. pytest does not do that. Note that
`nose2 choose to avoid this sys.path/import hackery <https://nose2.readthedocs.io/en/latest/differences.html#test-discovery-and-loading>`_.

If you place a conftest.py file in the root directory of your project
Expand All @@ -66,16 +65,34 @@ Unsupported idioms / known issues

- no nose-configuration is recognized.

- ``yield``-based methods are unsupported as of pytest 4.1.0. They are
- ``yield``-based methods are
fundamentally incompatible with pytest because they don't support fixtures
properly since collection and test execution are separated.

Here is a table comparing the default supported naming conventions for both
nose and pytest.

========= ========================== ======= =====
what default naming convention pytest nose
========= ========================== ======= =====
module ``test*.py`` ✅
module ``test_*.py`` ✅ ✅
module ``*_test.py`` ✅
module ``*_tests.py``
class ``*(unittest.TestCase)`` ✅ ✅
method ``test_*`` ✅ ✅
class ``Test*`` ✅
method ``test_*`` ✅
function ``test_*`` ✅
========= ========================== ======= =====


Migrating from nose to pytest
------------------------------

`nose2pytest <https://github.com/pytest-dev/nose2pytest>`_ is a Python script
and pytest plugin to help convert Nose-based tests into pytest-based tests.
Specifically, the script transforms nose.tools.assert_* function calls into
Specifically, the script transforms ``nose.tools.assert_*`` function calls into
raw assert statements, while preserving format of original arguments
as much as possible.

Expand Down