Elegant assertions library.
This is currently a work in progress.
expecting.dict: Dictionary assertions, combined with other assertions makes it easier to verify complex dictionary schemas.expecting.list: Utility assertions, like order agnostic comparisons.expecting.enum: Enum related assertions, checking values, names, or instances.expecting.number: Simple number comparisons, the small building blocks for more complex structured data checking.expecting.string: A variety of formats like date and time, URL, UUID.pip install expecting
poetry add expecting --group dev
Expecting consists of a set of assertion objects that can be used with assert statements in a clear, readable way.
Most common assertion will be covered under a structured set of modules, following an intuitive naming schema:
import expecting
assert '2023-10-11' == expecting.string.datetime.iso8601_day()
Here, the expcting.string.datetime module introduces a handful of factory methods for asserting that the value is a
string representing a date and time format.
It's specially useful with pytest and its amazing error messages, where an assertion failure message would look something like:
string/test_datetime.py:7 (test_iso8601_full_matches[2023/10/11 13:01:10])
'2023/10/11 13:01:10' != ~= <datetime as "%Y-%m-%dT%H:%M:%S.%f%z">
Expected :~= <datetime as "%Y-%m-%dT%H:%M:%S.%f%z">
Actual :'2023/10/11 13:01:10'
<Click to see difference>
datetime_str = '2023/10/11 13:01:10'
@pytest.mark.parametrize(
'datetime_str',
(
'2023/10/11 13:01:10',
)
)
def test_iso8601_full_matches(datetime_str: str):
> assert datetime_str == expecting.string.datetime.iso8601_full()
E assert '2023/10/11 13:01:10' == ~= <datetime as "%Y-%m-%dT%H:%M:%S.%f%z">
...
The ~= symbol prefixing the expected value is used denote this value is an "expecting object".
Feel free to create issues or merge requests with any improvement or fix you might find useful.
expecting.dict
expecting.enum
expecting.list
expecting.number
expecting.string
expecting.string.datetime
expecting.string.datetime.iso8601_fullexpecting.string.datetime.iso8601_millisecondexpecting.string.datetime.iso8601_secondexpecting.string.datetime.iso8601_minuteexpecting.string.datetime.iso8601_hourexpecting.string.datetime.iso8601_dayexpecting.string.datetime.iso8601_monthexpecting.string.datetime.iso8601_yearexpecting.string.uuid
expecting.dictexpecting.dict.containingAsserts that a dictionary contains a sub-dictionary.
import expecting
current = {
'color': 'yellow',
'positions': [(1, 1), (2, 3), (4, 2)],
}
assert current == expecting.dict.containing({
'positions': expecting.list.containing([(2, 3)]),
'color': 'yellow',
})
expecting.enumexpecting.enum.any_value_ofAsserts that a value represents a specific enum.
import expecting
from enum import Enum
class AnyEnum(str, Enum):
OK = 'OK'
assert 'OK' == expecting.enum.any_value_of(AnyEnum)
assert 'NOK' != expecting.enum.any_value_of(AnyEnum)
expecting.listexpecting.list.containingAsserts that a list contains a sub-list. Order is important.
import expecting
current = [1, 2, 3]
assert current == expecting.list.containing([2, 3])
expecting.list.unorderedAsserts that a list contains all the values, disregarding their order.
import expecting
current = [1, 2, 3]
assert current == expecting.list.unordered([3, 1, 2])
expecting.numberDisclaimer: of course writing assert a >= 1 is much easier and should be the preferred way to.
The functions under this namespace are intended for combined usage with other expecting objects for complex schema validations.
expecting.number.anyAsserts any type of number.
import expecting.number
assert 1 == expecting.number.any()
assert 0 == expecting.number.any()
assert -1.4 == expecting.number.any()
assert 'inf' == expecting.number.any()
expecting.number.geAsserts number is greater than or equal to (>=) given value.
import expecting
assert 10 == expecting.number.ge(10)
expecting.number.leAsserts number is lesser than or equal to (<=) given value.
import expecting
assert 10 == expecting.number.le(10)
expecting.number.gtAsserts number is greater than (>) given value.
import expecting
assert 10 == expecting.number.gt(9)
expecting.number.ltAsserts number is lesser than (<) given value.
import expecting
assert 10 == expecting.number.lt(11)
expecting.number.eqAsserts number is equals to given value.
import expecting
assert 10 == expecting.number.eq(10)
expecting.number.neAsserts number is not equals to given value.
import expecting
assert 10 == expecting.number.ne(9)
expecting.stringexpecting.string.datetimeexpecting.string.datetime.iso8601_fullAsserts string is a valid ISO8601 full format, considering the timezone Z or UTC offset versions.
from datetime import datetime
import expecting
assert datetime.now().strftime('%Y-%m-%dT%H:%M:%S.%f+000000.000000') == expecting.string.datetime.iso8601_full()
assert datetime.now().strftime('%Y-%m-%dT%H:%M:%S.%fZ') == expecting.string.datetime.iso8601_full()
expecting.string.datetime.iso8601_millisecondAsserts string is a valid ISO8601 format up to the milliseconds.
from datetime import datetime
import expecting
assert datetime.now().strftime('%Y-%m-%dT%H:%M:%S.%f') == expecting.string.datetime.iso8601_millisecond()
expecting.string.datetime.iso8601_secondAsserts string is a valid ISO8601 format up to the seconds
from datetime import datetime
import expecting
assert datetime.now().strftime('%Y-%m-%dT%H:%M:%S') == expecting.string.datetime.iso8601_second()
expecting.string.datetime.iso8601_minuteAsserts string is a valid ISO8601 format up to the minutes.
from datetime import datetime
import expecting
assert datetime.now().strftime('%Y-%m-%dT%H:%M') == expecting.string.datetime.iso8601_minute()
expecting.string.datetime.iso8601_hourAsserts string is a valid ISO8601 format up to the hours.
from datetime import datetime
import expecting
assert datetime.now().strftime('%Y-%m-%dT%H') == expecting.string.datetime.iso8601_hour()
expecting.string.datetime.iso8601_dayAsserts string is a valid ISO8601 format up to the day.
from datetime import datetime
import expecting
assert datetime.now().strftime('%Y-%m-%d') == expecting.string.datetime.iso8601_day()
expecting.string.datetime.iso8601_monthAsserts string is a valid ISO8601 format up to the month.
from datetime import datetime
import expecting
assert datetime.now().strftime('%Y-%m') == expecting.string.datetime.iso8601_month()
expecting.string.datetime.iso8601_yearAsserts string is a valid ISO8601 format up to the Year.
from datetime import datetime
import expecting
assert datetime.now().strftime('%Y') == expecting.string.datetime.iso8601_year()
expecting.string.uuidexpecting.string.uuid.v1Asserts that a string is a valid UUID v1 hex
import uuid
import expecting
assert str(uuid.uuid1()) == expecting.string.uuid.v1()
expecting.string.uuid.v3Asserts that a string is a valid UUID v3 hex
import uuid
import expecting
assert str(uuid.uuid3(uuid.uuid1(), 'bogus')) == expecting.string.uuid.v3()
expecting.string.uuid.v4Asserts that a string is a valid UUID v4 hex
import uuid
import expecting
assert str(uuid.uuid4()) == expecting.string.uuid.v4()
expecting.string.uuid.v5Asserts that a string is a valid UUID v5 hex
import uuid
import expecting
assert str(uuid.uuid5(uuid.uuid1(), 'bogus')) == expecting.string.uuid.v5()
expecting.string.uuid.hexAsserts that a string is a valid UUID hex, disregarding the version.
import uuid
import expecting
assert str(uuid.uuid1()) == expecting.string.uuid.hex()
assert str(uuid.uuid3(uuid.uuid1(), 'bogus')) == expecting.string.uuid.hex()
assert str(uuid.uuid4()) == expecting.string.uuid.hex()
assert str(uuid.uuid5(uuid.uuid1(), 'bogus')) == expecting.string.uuid.hex()
FAQs
Elegant assertions library
We found that expecting demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket Fix 2.0 brings targeted CVE remediation, smarter upgrade planning, and broader ecosystem support to help developers get to zero alerts.
Security News
Socket CEO Feross Aboukhadijeh joins Risky Business Weekly to unpack recent npm phishing attacks, their limited impact, and the risks if attackers get smarter.
Product
Socket’s new Tier 1 Reachability filters out up to 80% of irrelevant CVEs, so security teams can focus on the vulnerabilities that matter.