1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
Welcome to nose2
================
nose2's extends ``unittest`` to make testing nicer.
nose2 vs nose
-------------
``nose2`` originated as the successor to ``nose``.
``nose2`` is a distinct project and does not support all of the behaviors of ``nose``.
See `differences`_ for a thorough rundown.
nose2 vs pytest
---------------
`pytest`_ is an excellent test framework and we encourage users to consider
it for new projects.
It has a bigger team of maintainers and a larger community of users.
Quickstart
----------
Because ``nose2`` is based on unittest, you can start from the Python Standard
Library's `documentation for unittest <https://docs.python.org/library/unittest.html>`_
and then use nose2 to add value on top of that.
``nose2`` looks for tests in Python files whose names start with ``test`` and
runs every test function it discovers.
Here's an example of a simple test, written in typical unittest style:
.. code-block:: python
# in test_simple.py
import unittest
class TestStrings(unittest.TestCase):
def test_upper(self):
self.assertEqual("spam".upper(), "SPAM")
You can then run this test like so::
$ nose2 -v
test_upper (test_simple.TestStrings) ... ok
----------------------------------------------------------------------
Ran 1 test in 0.000s
OK
However, ``nose2`` supports more testing configuration and provides more tools
than ``unittest`` on its own.
For example, this test exercises just a few of ``nose2``'s features:
.. code-block:: python
# in test_fancy.py
from nose2.tools import params
@params("Sir Bedevere", "Miss Islington", "Duck")
def test_is_knight(value):
assert value.startswith('Sir')
and then run this like so::
$ nose2 -v --pretty-assert
test_fancy.test_is_knight:1
'Sir Bedevere' ... ok
test_fancy.test_is_knight:2
'Miss Islington' ... FAIL
test_fancy.test_is_knight:3
'Duck' ... FAIL
======================================================================
FAIL: test_fancy.test_is_knight:2
'Miss Islington'
----------------------------------------------------------------------
Traceback (most recent call last):
File "/mnt/ebs/home/sirosen/tmp/test_fancy.py", line 6, in test_is_knight
assert value.startswith('Sir')
AssertionError
>>> assert value.startswith('Sir')
values:
value = 'Miss Islington'
value.startswith = <built-in method startswith of str object at 0x7f3c3172f430>
======================================================================
FAIL: test_fancy.test_is_knight:3
'Duck'
----------------------------------------------------------------------
Traceback (most recent call last):
File "/mnt/ebs/home/sirosen/tmp/test_fancy.py", line 6, in test_is_knight
assert value.startswith('Sir')
AssertionError
>>> assert value.startswith('Sir')
values:
value = 'Duck'
value.startswith = <built-in method startswith of str object at 0x7f3c3172d490>
----------------------------------------------------------------------
Ran 3 tests in 0.001s
FAILED (failures=2)
Full Docs
---------
Full documentation for ``nose2`` is available at `docs.nose2.io`_
Versions and Support
--------------------
Changelog and Version Scheme
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
nose2 versions are numbered ``0.MAJOR.MINOR``. Minor releases contain bugfixes or
smaller features. Major features or backwards incompatible changes are done in
major releases.
For a full description of all past versions and changes, see the `changelog`_.
Python Versions
~~~~~~~~~~~~~~~
nose2 requires Python 3.
It supports all versions currently supported by the CPython team, and also aims
to support PyPy and cpython betas.
Python 2
********
Python 2 is no longer supported. The `0.12.x line of releases <py2line>`_
contains the last versions which supported Python 2.
Users of Python 2 should understand that Python 2 is EOL and the Python 2
support line for ``nose2`` is similarly considered EOL.
.. note::
Fixes to 0.12.x may still be accepted on an as-needed basis for a short
while as the python3-only line of releases gets started.
Contributing
------------
If you want to make contributions, please read the `contributing`_ guide.
.. _py2line: https://github.com/nose-devs/nose2/tree/0.12.x-line
.. _differences: https://docs.nose2.io/en/latest/differences.html
.. _changelog: https://docs.nose2.io/en/latest/changelog.html
.. _pytest: http://pytest.readthedocs.io/en/latest/
.. _contributing: https://github.com/nose-devs/nose2/blob/main/contributing.rst
.. _docs.nose2.io: https://docs.nose2.io/en/latest/
|
