test_ok1/doc/en/nose.rst

.. _`noseintegration`:

Running tests written for nose
=======================================

.. include:: links.inc

``pytest`` has basic support for running tests written for nose_.

.. _nosestyle:

Usage
-------------

After :ref:`installation` type::

    python setup.py develop  # make sure tests can import our package
    pytest  # instead of 'nosetests'

and you should be able to run your nose style tests and
make use of pytest's capabilities.

Supported nose Idioms
----------------------

* setup and teardown at module/class/method level
* SkipTest exceptions and markers
* setup/teardown decorators
* ``yield``-based tests and their setup
* ``__test__`` attribute on modules/classes/functions
* general usage of nose utilities

Unsupported idioms / known issues
----------------------------------

- unittest-style ``setUp, tearDown, setUpClass, tearDownClass``
  are recognized only on ``unittest.TestCase`` classes but not
  on plain classes.  ``nose`` supports these methods also on plain
  classes but pytest deliberately does not.  As nose and pytest already
  both support ``setup_class, teardown_class, setup_method, teardown_method``
  it doesn't seem useful to duplicate the unittest-API like nose does.
  If you however rather think pytest should support the unittest-spelling on
  plain classes please post `to this issue
  <https://github.com/pytest-dev/pytest/issues/377/>`_.

- nose imports test modules with the same import path (e.g.
  ``tests.test_mod``) 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 `#268 <https://github.com/pytest-dev/pytest/issues/268>`_ for adding some support.  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
  (as determined by pytest) pytest will run tests "nose style" against
  the code below that directory by adding it to your ``sys.path`` instead of
  running against your installed code.

  You may find yourself wanting to do this if you ran ``python setup.py install``
  to set up your project, as opposed to ``python setup.py develop`` or any of
  the package manager equivalents.  Installing with develop in a
  virtual environment like Tox is recommended over this pattern.

- nose-style doctests are not collected and executed correctly,
  also doctest fixtures don't work.

- no nose-configuration is recognized.

- ``yield``-based methods don't support ``setup`` properly because
  the ``setup`` method is always called in the same class instance.
  There are no plans to fix this currently because ``yield``-tests
  are deprecated in pytest 3.0, with ``pytest.mark.parametrize``
  being the recommended alternative.
docs warnings as errors and initial page similar to README * Changed "index" to be more similar to the README (#1708). * Fixes numerous issues like missing documents, syntax errors, etc (#1829, #432). * Mention all docs in "contents.rst" so it's easier for users to locate (#1112). * Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors. Fixes #432, Fixes #1112, Fixes #1708, Fixes #1829 2016-08-23 10:35:41 +08:00			.. _`noseintegration`:

Capitalised start of headlines, added -ing to a few headlines. 2011-09-06 17:43:42 +08:00			`Running tests written for nose`
some more improvements and updates to docs, add release announcements 2010-11-06 18:38:53 +08:00			`=======================================`

			`.. include:: links.inc`

replace py.test module references with pytest The only remaining 'py.test' references are: * those referring to the 'py.test' executable * those in code explicitly testing py.test/pytest module compatibility * those in old CHANGES documentation * those in documentation generated based on external data * those in seemingly unfinished & unmaintained Japanese documentation Minor stylistic changes and typo corrections made to documentation next to several applied py.test --> pytest content changes. 2014-01-18 19:31:33 +08:00			``pytest`` has basic support for running tests written for nose_.
some more improvements and updates to docs, add release announcements 2010-11-06 18:38:53 +08:00
improve docs further, refine unittest docs, rename ``autoactive`` to ``autouse`` to better match ``@pytest.mark.usefixtures`` naming. 2012-10-12 20:52:36 +08:00			`.. _nosestyle:`

some more improvements and updates to docs, add release announcements 2010-11-06 18:38:53 +08:00			`Usage`
			`-------------`

improve docs further, refine unittest docs, rename ``autoactive`` to ``autouse`` to better match ``@pytest.mark.usefixtures`` naming. 2012-10-12 20:52:36 +08:00			After :ref:`installation` type::
some more improvements and updates to docs, add release announcements 2010-11-06 18:38:53 +08:00
Fix instructions for nose users. --HG-- branch : fix-nose-docs 2013-08-23 18:59:57 +08:00			`python setup.py develop # make sure tests can import our package`
Introduce pytest command as recommended entry point Fixes #1629 2016-06-21 22:16:57 +08:00			`pytest # instead of 'nosetests'`
some more improvements and updates to docs, add release announcements 2010-11-06 18:38:53 +08:00
refine docs and docstrings, fix some small bits here and there while doing that. 2010-11-18 21:56:16 +08:00			`and you should be able to run your nose style tests and`
replace py.test module references with pytest The only remaining 'py.test' references are: * those referring to the 'py.test' executable * those in code explicitly testing py.test/pytest module compatibility * those in old CHANGES documentation * those in documentation generated based on external data * those in seemingly unfinished & unmaintained Japanese documentation Minor stylistic changes and typo corrections made to documentation next to several applied py.test --> pytest content changes. 2014-01-18 19:31:33 +08:00			`make use of pytest's capabilities.`
some more improvements and updates to docs, add release announcements 2010-11-06 18:38:53 +08:00
			`Supported nose Idioms`
			`----------------------`

			`* setup and teardown at module/class/method level`
			`* SkipTest exceptions and markers`
			`* setup/teardown decorators`
Document limitations for yield-tests in nose Also add nose doc to the root toctree Closes #1716 2016-07-12 23:41:40 +08:00			* ``yield``-based tests and their setup
support nose-style ``__test__`` attribute on modules, classes and functions, including unittest-style Classes. If set to True, the test will not be collected. --HG-- branch : nose_test_attr 2014-04-10 18:46:27 +08:00			* ``__test__`` attribute on modules/classes/functions
some more improvements and updates to docs, add release announcements 2010-11-06 18:38:53 +08:00			`* general usage of nose utilities`

refine docs and docstrings, fix some small bits here and there while doing that. 2010-11-18 21:56:16 +08:00			`Unsupported idioms / known issues`
some more improvements and updates to docs, add release announcements 2010-11-06 18:38:53 +08:00			`----------------------------------`

replace py.test module references with pytest The only remaining 'py.test' references are: * those referring to the 'py.test' executable * those in code explicitly testing py.test/pytest module compatibility * those in old CHANGES documentation * those in documentation generated based on external data * those in seemingly unfinished & unmaintained Japanese documentation Minor stylistic changes and typo corrections made to documentation next to several applied py.test --> pytest content changes. 2014-01-18 19:31:33 +08:00			- unittest-style ``setUp, tearDown, setUpClass, tearDownClass``
fix issue377 by clarifying in the nose-compat docs that pytest does not duplicate the unittest-API into the "plain" namespace. 2013-11-22 21:07:56 +08:00			are recognized only on ``unittest.TestCase`` classes but not
			on plain classes. ``nose`` supports these methods also on plain
replace py.test module references with pytest The only remaining 'py.test' references are: * those referring to the 'py.test' executable * those in code explicitly testing py.test/pytest module compatibility * those in old CHANGES documentation * those in documentation generated based on external data * those in seemingly unfinished & unmaintained Japanese documentation Minor stylistic changes and typo corrections made to documentation next to several applied py.test --> pytest content changes. 2014-01-18 19:31:33 +08:00			`classes but pytest deliberately does not. As nose and pytest already`
fix issue377 by clarifying in the nose-compat docs that pytest does not duplicate the unittest-API into the "plain" namespace. 2013-11-22 21:07:56 +08:00			both support ``setup_class, teardown_class, setup_method, teardown_method``
			`it doesn't seem useful to duplicate the unittest-API like nose does.`
			`If you however rather think pytest should support the unittest-spelling on`
			plain classes please post `to this issue
Change links from bitbucket to GitHub 2015-06-16 05:28:31 +08:00			<https://github.com/pytest-dev/pytest/issues/377/>`_.
add a note to the documentation that pytest does not mimick nose try to perform "import isolation". Addresses issue268. 2013-11-22 22:12:12 +08:00
			`- nose imports test modules with the same import path (e.g.`
			``tests.test_mod``) 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`
Small formatting fixes to nose.rst 2017-04-07 10:01:26 +08:00			but there is discussion in `#268 <https://github.com/pytest-dev/pytest/issues/268>`_ for adding some support. Note that
Convert readthedocs link for their .org -> .io migration for hosted projects As per their email ‘Changes to project subdomains’: > Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard. Test Plan: Manually visited all the links I’ve modified. One was not modified - `http://media.readthedocs.org/epub/pytest/latest/pytest.epub` - since it doesn't work on `readthedocs.io`. 2016-05-19 00:12:39 +08:00			`nose2 choose to avoid this sys.path/import hackery <https://nose2.readthedocs.io/en/latest/differences.html#test-discovery-and-loading>`_.
replace py.test module references with pytest The only remaining 'py.test' references are: * those referring to the 'py.test' executable * those in code explicitly testing py.test/pytest module compatibility * those in old CHANGES documentation * those in documentation generated based on external data * those in seemingly unfinished & unmaintained Japanese documentation Minor stylistic changes and typo corrections made to documentation next to several applied py.test --> pytest content changes. 2014-01-18 19:31:33 +08:00
moved documentation of conftest.py hack to nose.rst 2017-04-07 09:01:03 +08:00			`If you place a conftest.py file in the root directory of your project`
			`(as determined by pytest) pytest will run tests "nose style" against`
Small formatting fixes to nose.rst 2017-04-07 10:01:26 +08:00			the code below that directory by adding it to your ``sys.path`` instead of
moved documentation of conftest.py hack to nose.rst 2017-04-07 09:01:03 +08:00			`running against your installed code.`

Small formatting fixes to nose.rst 2017-04-07 10:01:26 +08:00			You may find yourself wanting to do this if you ran ``python setup.py install``
			to set up your project, as opposed to ``python setup.py develop`` or any of
moved documentation of conftest.py hack to nose.rst 2017-04-07 09:01:03 +08:00			`the package manager equivalents. Installing with develop in a`
			`virtual environment like Tox is recommended over this pattern.`

some more improvements and updates to docs, add release announcements 2010-11-06 18:38:53 +08:00			`- nose-style doctests are not collected and executed correctly,`
refine docs and docstrings, fix some small bits here and there while doing that. 2010-11-18 21:56:16 +08:00			`also doctest fixtures don't work.`
some more improvements and updates to docs, add release announcements 2010-11-06 18:38:53 +08:00
Document limitations for yield-tests in nose Also add nose doc to the root toctree Closes #1716 2016-07-12 23:41:40 +08:00			`- no nose-configuration is recognized.`

			- ``yield``-based methods don't support ``setup`` properly because
			the ``setup`` method is always called in the same class instance.
			There are no plans to fix this currently because ``yield``-tests
			are deprecated in pytest 3.0, with ``pytest.mark.parametrize``
			`being the recommended alternative.`

some more improvements and updates to docs, add release announcements 2010-11-06 18:38:53 +08:00
moved documentation of conftest.py hack to nose.rst 2017-04-07 09:01:03 +08:00