Useful assertion utilities for use with pytest
Project description
pytest-assert-utils
Handy assertion utilities for use with pytest
Installation
pip install pytest-assert-utils
Usage
assert_dict_is_subset
def assert_dict_is_subset(subset, superset, recursive=True)
Assert subset
is a non-strict subset of superset
If this assertion fails, a pretty diff will be printed by pytest.
>>> from pytest_assert_utils import assert_dict_is_subset
>>> expected = {'a': 12}
>>> actual = {'b': 20, 'a': 12}
>>> assert_dict_is_subset(expected, actual)
>>> expected = {'a': 12}
>>> actual = {'b': 50000}
>>> assert_dict_is_subset(expected, actual)
Traceback (most recent call last):
...
AssertionError
assert_model_attrs
def assert_model_attrs(instance, _d=UNSET, **attrs)
Assert a model instance has the specified attr values
May be passed a dict of attrs, or kwargs as attrs
>>> from pytest_assert_utils import assert_model_attrs
>>> from collections import namedtuple
>>> Model = namedtuple('Model', 'id,key,other_key,parent', defaults=(None,)*4)
>>> assert_model_attrs(Model(), {})
>>> assert_model_attrs(Model(key='value'), {'key': 'value'})
>>> assert_model_attrs(Model(key='value'), key='value')
>>> assert_model_attrs(Model(key='value'), key='not the value')
Traceback (most recent call last):
...
AssertionError
>>> assert_model_attrs(Model(key='value', other_key='other_value'), key='value')
Any
Meta-value which compares True to any object (of the specified type(s))
>>> from pytest_assert_utils import util
>>> util.Any() == 'stuff'
True
>>> util.Any() == 1
True
>>> util.Any() == None
True
>>> util.Any() == object()
True
>>> util.Any(int) == 1
True
>>> util.Any(int) == '1'
False
Optional
Meta-value which compares True to None or the optionally specified value
>>> from pytest_assert_utils import util
>>> util.Optional() == None
True
>>> util.Optional() is None # this will not work!
False
>>> util.Optional(24) == 24
True
>>> util.Optional(24) == None
True
>>> util.Optional(Any(int)) == 1
True
>>> util.Optional(Any(int)) == None
True
>>> util.Optional(Any(int)) == '1'
False
Collection
Special class enabling equality comparisons to check items in any collection (list, set, tuple, etc)
>>> from pytest_assert_utils import util
>>> util.Collection.containing(1) == [1, 2, 3]
True
>>> util.Collection.containing(1) == {1, 2, 3}
True
>>> util.Collection.containing(1) == (1, 2, 3)
True
>>> util.Collection.containing(1) == [4, 5, 6]
False
>>> util.Collection.containing(1) == {4, 5, 6}
False
>>> util.Collection.containing(1) == (4, 5, 6)
False
List
Special class enabling equality comparisons to check items in a list
>>> from pytest_assert_utils import util
>>> util.List.containing(1) == [1, 2, 3]
True
>>> util.List.containing(1) == [4, 5, 6]
False
>>> util.List.not_containing(1) == [1, 2, 3]
False
>>> util.List.not_containing(1) == [4, 5, 6]
True
>>> util.List.empty() == [1, 2, 3]
False
>>> util.List.empty() == []
True
>>> util.List.not_empty() == [1, 2, 3]
True
>>> util.List.not_empty() == []
False
Set
Special class enabling equality comparisons to check items in a set
>>> from pytest_assert_utils import util
>>> util.Set.containing(1) == {1, 2, 3}
True
>>> util.Set.containing(1) == {4, 5, 6}
False
>>> util.Set.not_containing(1) == {1, 2, 3}
False
>>> util.Set.not_containing(1) == {4, 5, 6}
True
>>> util.Set.empty() == {1, 2, 3}
False
>>> util.Set.empty() == set()
True
>>> util.Set.not_empty() == {1, 2, 3}
True
>>> util.Set.not_empty() == set()
False
Dict
Special class enabling equality comparisons to check items in a dict
>>> from pytest_assert_utils import util
>>> util.Dict.containing('a') == {'a': 1, 'b': 2}
True
>>> util.Dict.containing(a=1) == {'a': 1, 'b': 2}
True
>>> util.Dict.containing({'a': 1}) == {'a': 1, 'b': 2}
True
>>> util.Dict.containing('a') == {'b': 2}
False
>>> util.Dict.containing(a=1) == {'b': 2}
False
>>> util.Dict.containing({'a': 1}) == {'b': 2}
False
>>> util.Dict.not_containing('a') == {'a': 1, 'b': 2}
False
>>> util.Dict.not_containing(a=1) == {'a': 1, 'b': 2}
False
>>> util.Dict.not_containing({'a': 1}) == {'a': 1, 'b': 2}
False
>>> util.Dict.not_containing('a') == {'b': 2}
True
>>> util.Dict.not_containing(a=1) == {'b': 2}
True
>>> util.Dict.not_containing({'a': 1}) == {'b': 2}
True
>>> util.Dict.empty() == {'a': 1, 'b': 2, 'c': 3}
False
>>> util.Dict.empty() == {}
True
>>> util.Dict.not_empty() == {'a': 1, 'b': 2, 'c': 3}
True
>>> util.Dict.not_empty() == {}
False
Str
Special class enabling equality comparisons to check items in a string
>>> from pytest_assert_utils import util
>>> util.Str.containing('app') == 'apple'
True
>>> util.Str.containing('app') == 'happy'
True
>>> util.Str.containing('app') == 'banana'
False
>>> util.Str.not_containing('app') == 'apple'
False
>>> util.Str.not_containing('app') == 'happy'
False
>>> util.Str.not_containing('app') == 'banana'
True
>>> util.Str.empty() == 'hamster'
False
>>> util.Str.empty() == ''
True
>>> util.Str.not_empty() == 'hamster'
True
>>> util.Str.not_empty() == ''
False
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pytest-assert-utils-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c8677c37584c7d9593fa06eb83f4a85e11e22a920d8db3aabbefc5ab62c7eef0 |
|
MD5 | c73f3b82e453ad43cd52243b6f80395b |
|
BLAKE2b-256 | d42cd05f9732b06c757b5c688967cf4f04c9f20a44b63ccff28460381221c9f6 |
Hashes for pytest_assert_utils-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9984cfa650c652d2be7a2a8ca4226e829e5371d18c42979136bd6ec430164108 |
|
MD5 | 2e4cebe549eea0014b4c48cc09be719e |
|
BLAKE2b-256 | 378dfa711b49b90f02a4d4636fa55774dfde0f2d67903685fd9d2c93ea0b2b71 |