numpy.testing._private.nosetester.NoseTester

class documentation

class NoseTester: (source)

Nose test runner.

This class is made available as numpy.testing.Tester, and a test function is typically added to a package's __init__.py like so:

from numpy.testing import Tester
test = Tester().test

Calling this test function finds and runs all tests associated with the package and all its sub-packages.

Parameters
package	The package to test. If a string, this should be the full path to the package. If None (default), `package` is set to the module from which `NoseTester` is initialized.
raise_warnings	This specifies which warnings to configure as 'raise' instead of being shown once during the test execution. Valid strings are: "develop" : equals `(Warning,)` "release" : equals `()`, don't raise on any warnings. Default is "release".
depth	If `package` is None, then this can be used to initialize from the module of the caller of (the caller of (...)) the code that initializes `NoseTester`. Default of 0 means the module of the immediate caller; higher values are useful for utility routines that want to initialize `NoseTester` objects on behalf of other code.

Method	`__init__`	Undocumented
Method	`bench`	Run benchmarks for module using nose.
Method	`prepare_test_args`	Run tests for module using nose.
Method	`test`	Run tests for module using nose.
Instance Variable	`check_fpu_mode`	Undocumented
Instance Variable	`package_name`	Name of the package to test.
Instance Variable	`package_path`	Full path to the package to test.
Instance Variable	`raise_warnings`	Undocumented
Method	`_get_custom_doctester`	Return instantiated plugin for doctests
Method	`_show_system_info`	Undocumented
Method	`_test_argv`	Generate argv for nosetest command

def __init__(self, package=None, raise_warnings='release', depth=0, check_fpu_mode=False): (source) ¶

Undocumented

def bench(self, label='fast', verbose=1, extra_argv=None): (source) ¶

Run benchmarks for module using nose.

Notes

Benchmarks are like tests, but have names starting with "bench" instead of "test", and can be found under the "benchmarks" sub-directory of the module.

Each NumPy module exposes bench in its namespace to run all benchmarks for it.

Examples

>>> success = np.lib.bench() #doctest: +SKIP
Running benchmarks for numpy.lib
...
using 562341 items:
unique:
0.11
unique1d:
0.11
ratio: 1.0
nUnique: 56230 == 56230
...
OK

>>> success #doctest: +SKIP
True

Parameters
label:{'fast', 'full', '', attribute identifier}, optional	Identifies the benchmarks to run. This can be a string to pass to the nosetests executable with the '-A' option, or one of several special values. Special values are: 'fast' - the default - which corresponds to the `nosetests -A` option of 'not slow'. 'full' - fast (as above) and slow benchmarks as in the 'no -A' option to nosetests - this is the same as ''. None or '' - run all tests. attribute_identifier - string passed directly to nosetests as '-A'.
verbose:`int`, optional	Verbosity value for benchmark outputs, in the range 1-10. Default is 1.
extra_argv:`list`, optional	List with any extra arguments to pass to nosetests.
Returns
`bool`	success - Returns True if running the benchmarks works, False if an error occurred.

def prepare_test_args(self, label='fast', verbose=1, extra_argv=None, doctests=False, coverage=False, timer=False): (source) ¶

Run tests for module using nose.

This method does the heavy lifting for the test method. It takes all the same arguments, for details see test.

See Also

test

def test(self, label='fast', verbose=1, extra_argv=None, doctests=False, coverage=False, raise_warnings=None, timer=False): (source) ¶

Run tests for module using nose.

Notes

Each NumPy module exposes test in its namespace to run all tests for it. For example, to run all tests for numpy.lib:

>>> np.lib.test() #doctest: +SKIP

Examples

>>> result = np.lib.test() #doctest: +SKIP
Running unit tests for numpy.lib
...
Ran 976 tests in 3.933s

>>> result.errors #doctest: +SKIP
[]
>>> result.knownfail #doctest: +SKIP
[]

Parameters
label:{'fast', 'full', '', attribute identifier}, optional	Identifies the tests to run. This can be a string to pass to the nosetests executable with the '-A' option, or one of several special values. Special values are: 'fast' - the default - which corresponds to the `nosetests -A` option of 'not slow'. 'full' - fast (as above) and slow tests as in the 'no -A' option to nosetests - this is the same as ''. None or '' - run all tests. attribute_identifier - string passed directly to nosetests as '-A'.
verbose:`int`, optional	Verbosity value for test outputs, in the range 1-10. Default is 1.
extra_argv:`list`, optional	List with any extra arguments to pass to nosetests.
doctests:`bool`, optional	If True, run doctests in module. Default is False.
coverage:`bool`, optional	If True, report coverage of NumPy code. Default is False. (This requires the coverage module).
raise_warnings:`None`, `str` or `sequence` of `warnings`, optional	This specifies which warnings to configure as 'raise' instead of being shown once during the test execution. Valid strings are: "develop" : equals `(Warning,)` "release" : equals `()`, do not raise on any warnings.
timer:`bool` or `int`, optional	Timing of individual tests with `nose-timer` (which needs to be installed). If True, time tests and report on all of them. If an integer (say `N`), report timing results for `N` slowest tests.
Returns
`object`	result - Returns the result of running the tests as a `nose.result.TextTestResult` object.

check_fpu_mode = (source) ¶

Undocumented

package_name: str = (source) ¶

Name of the package to test.

package_path: str = (source) ¶

Full path to the package to test.

raise_warnings: None, str or sequence of warnings, optional = (source) ¶

Undocumented

def _get_custom_doctester(self): (source) ¶

Return instantiated plugin for doctests

Allows subclassing of this class to override doctester

A return value of None means use the nose builtin doctest plugin

def _show_system_info(self): (source) ¶

Undocumented

def _test_argv(self, label, verbose, extra_argv): (source) ¶

Generate argv for nosetest command

Parameters
label:{'fast', 'full', '', attribute identifier}, optional	see `test` docstring
verbose:`int`, optional	Verbosity value for test outputs, in the range 1-10. Default is 1.
extra_argv:`list`, optional	List with any extra arguments to pass to nosetests.
Returns
`list`	argv - command line arguments that will be passed to nose