https://github.com/loic-simon/readycheck
Run custom checks on classes attributes when accessing them
https://github.com/loic-simon/readycheck
Last synced: 8 months ago
JSON representation
Run custom checks on classes attributes when accessing them
- Host: GitHub
- URL: https://github.com/loic-simon/readycheck
- Owner: loic-simon
- License: mit
- Created: 2022-05-05T18:10:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-05-05T22:48:00.000Z (over 3 years ago)
- Last Synced: 2025-01-26T12:47:27.807Z (11 months ago)
- Language: Python
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# readycheck
[](https://pypi.org/project/readycheck)
[](https://pypi.org/project/readycheck)
[](https://pypi.org/project/readycheck)
[](https://readycheck.readthedocs.io)
[](https://app.circleci.com/pipelines/github/loic-simon/readycheck)
Python package providing utilities to check classes attributes when accessing it.
## Installation
Use the package manager [pip](https://pypi.org/project/pip) to install readycheck:
```bash
pip install readycheck
```
### Dependencies
* Python **≥ 3.5**
## Goal
The goal of this module is to allow to add custom checks when accessing class
attributes.
It is designed to build classes that store objects not available at import time
(e.g. later fetched from a distant service). It avoid us the pain to check if
the connection has been established each time we need these objects: trying to
access them will automagically raise an exception if they are not ready.
## Usage
This package's main external API in the **`ReadyCheck`** class.
This class is **not meant** to be instantiated (see documentation for details),
but to be subclassed using a custom check function:
```py
from readycheck import ReadyCheck
class User(ReadyCheck, check_type=dict, check=lambda val: "name" in val):
john = {"id": "", "area": 2}
jane = {"id": "", "area": 5}
```
Usage:
```
>>> User.john
Traceback (most recent call last):
...
readycheck.NotReadyError: 'john' is not ready yet!
>>> john_data = User.get_raw("john")
>>> User.john = some_lib.load_user(john_data)
>>> User.john
{'id': '', 'area': 2, 'name': 'John Doe', 'subscribed': False}
```
Read [the docs](https://readycheck.readthedocs.io) for more information.
## Contributing
Pull requests are welcome. Do not hesitate to get in touch with me (see below)
for any question or suggestion about this project!
## License
This work is shared under [the MIT license](LICENSE).
© 2022 Loïc Simon ([loic.simon@espci.org](mailto:loic.simon@espci.org))