https://github.com/smarie/python-vtypes
Validating types for python - use `isinstance()` to validate both type and value.
https://github.com/smarie/python-vtypes
check checker checking class instance type valid validate validation validator value
Last synced: 8 months ago
JSON representation
Validating types for python - use `isinstance()` to validate both type and value.
- Host: GitHub
- URL: https://github.com/smarie/python-vtypes
- Owner: smarie
- License: bsd-3-clause
- Created: 2020-01-21T16:33:26.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-25T14:03:45.000Z (over 5 years ago)
- Last Synced: 2025-05-07T17:11:50.731Z (8 months ago)
- Topics: check, checker, checking, class, instance, type, valid, validate, validation, validator, value
- Language: Python
- Homepage: https://smarie.github.io/python-vtypes/
- Size: 1.11 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# python validating types (vtypes)
*Validating types for python - use `isinstance()` to validate both type and value.*
[](https://pypi.python.org/pypi/vtypes/) [](https://travis-ci.org/smarie/python-vtypes) [](https://smarie.github.io/python-vtypes/junit/report.html) [](https://codecov.io/gh/smarie/python-vtypes)
[](https://smarie.github.io/python-vtypes/) [](https://pypi.python.org/pypi/vtypes/) [](https://pepy.tech/project/vtypes) [](https://pepy.tech/project/vtypes) [](https://github.com/smarie/python-vtypes/stargazers)
**TODO a few lines to describe**
**This is the readme for developers.** The documentation for users is available here: [https://smarie.github.io/python-vtypes/](https://smarie.github.io/python-vtypes/)
## Want to contribute ?
Contributions are welcome ! Simply fork this project on github, commit your contributions, and create pull requests.
Here is a non-exhaustive list of interesting open topics: [https://github.com/smarie/python-vtypes/issues](https://github.com/smarie/python-vtypes/issues)
## Installing all requirements
In order to install all requirements, including those for tests and packaging, use the following command:
```bash
pip install -r ci_tools/requirements-pip.txt
```
## Running the tests
This project uses `pytest`.
```bash
pytest -v vtypes/tests/
```
## Packaging
This project uses `setuptools_scm` to synchronise the version number. Therefore the following command should be used for development snapshots as well as official releases:
```bash
python setup.py egg_info bdist_wheel rotate -m.whl -k3
```
## Generating the documentation page
This project uses `mkdocs` to generate its documentation page. Therefore building a local copy of the doc page may be done using:
```bash
mkdocs build -f docs/mkdocs.yml
```
## Generating the test reports
The following commands generate the html test report and the associated badge.
```bash
pytest --junitxml=junit.xml -v vtypes/tests/
ant -f ci_tools/generate-junit-html.xml
python ci_tools/generate-junit-badge.py
```
### PyPI Releasing memo
This project is now automatically deployed to PyPI when a tag is created. Anyway, for manual deployment we can use:
```bash
twine upload dist/* -r pypitest
twine upload dist/*
```
### Merging pull requests with edits - memo
Ax explained in github ('get commandline instructions'):
```bash
git checkout -b - master
git pull https://github.com//python-vtypes.git --no-commit --ff-only
```
if the second step does not work, do a normal auto-merge (do not use **rebase**!):
```bash
git pull https://github.com//python-vtypes.git --no-commit
```
Finally review the changes, possibly perform some modifications, and commit.