numpy.testing._private.parameterized

module documentation
(source)

tl;dr: all code is licensed under simplified BSD, unless stated otherwise.

Unless stated otherwise in the source files, all code is copyright 2010 David Wolever <david@wolever.net>. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of David Wolever.

Class param Represents a single parameter to a test case.
Class parameterized Parameterize a test case:
Function default_doc_func Undocumented
Function default_name_func Undocumented
Function detect_runner Guess which test runner we're using by traversing the stack and looking for the first matching module. This should be reasonably safe, as it's done during test discovery where the test runner should be the stack frame immediately outside.
Function parameterized_argument_value_pairs Return tuples of parameterized arguments and their values.
Function set_test_runner Undocumented
Function short_repr A shortened repr of x which is guaranteed to be unicode:
Variable _param Undocumented
Variable _test_runner_aliases Undocumented
Variable _test_runner_guess Undocumented
Variable _test_runner_override Undocumented
Variable _test_runners Undocumented
def default_doc_func(func, num, p): (source)

Undocumented

def default_name_func(func, num, p): (source)

Undocumented

def detect_runner(): (source)

Guess which test runner we're using by traversing the stack and looking for the first matching module. This should be reasonably safe, as it's done during test discovery where the test runner should be the stack frame immediately outside.

def parameterized_argument_value_pairs(func, p): (source)

Return tuples of parameterized arguments and their values.

This is useful if you are writing your own doc_func function and need to know the values for each parameter name:

>>> def func(a, foo=None, bar=42, **kwargs): pass
>>> p = param(1, foo=7, extra=99)
>>> parameterized_argument_value_pairs(func, p)
[("a", 1), ("foo", 7), ("bar", 42), ("**kwargs", {"extra": 99})]

If the function's first argument is named self then it will be ignored:

>>> def func(self, a): pass
>>> p = param(1)
>>> parameterized_argument_value_pairs(func, p)
[("a", 1)]

Additionally, empty *args or **kwargs will be ignored:

>>> def func(foo, *args): pass
>>> p = param(1)
>>> parameterized_argument_value_pairs(func, p)
[("foo", 1)]
>>> p = param(1, 16)
>>> parameterized_argument_value_pairs(func, p)
[("foo", 1), ("*args", (16, ))]
def set_test_runner(name): (source)

Undocumented

def short_repr(x, n=64): (source)

A shortened repr of x which is guaranteed to be unicode:

>>> short_repr("foo")

u"foo" >>> short_repr("123456789", n=4) u"12...89"

_param = (source)

Undocumented

_test_runner_aliases: dict[str, str] = (source)

Undocumented

_test_runner_guess: bool = (source)

Undocumented

_test_runner_override: str = (source)

Undocumented

_test_runners = (source)

Undocumented