Safe assert for Python that can be used together with optimised mode
Project description
safe-assert
Allows users to write composable assert
s that are not stripped away in optimized mode.
Features
- Single simple, pythonic, fast, tested, typed, documented function. That's it!
- Because
safe_assert
is a function, it can be easily composed with other functions - Fully typed with annotations and checked with mypy, PEP561 compatible
Installation
pip install safe-assert
Examples
The usage is identical to assert
keyword, but a function:
from safe_assert import safe_assert
def sort_positive_numbers(numbers: List[int]) -> List[int]:
safe_assert(all(num >= 0 for num in numbers), 'found negative')
return sorted(numbers)
sort_positive_numbers([1, 2, 3]) # => will work
sort_positive_numbers([-1, 2, 3])
# => will fail in runtime with `AssertionError`
How is it different from regular assert
?
The major one is that it would not be stripped away with -O
flag.
So, it still allows to write declarative checks that are safe in production.
The second one is that you can compose it as any other regular function.
Useful in conjunction with dry-python
projects.
Internals
How does it work internally?
It internally raises AssertionError
that is also used by the assert
keyword itself.
See docs to learn more.
License
MIT.
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 safe_assert-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aec1348bf6baac240d263b1c69eb0c00c0d9dc90c9d73c76cb9ad30d98ea8fd1 |
|
MD5 | f51e3ab835e371a09081a5604858f5b3 |
|
BLAKE2b-256 | f0c5096a78bca1285c92384adf4d6517cfbcc1e52ce156583b962ca7fa93f2ab |