parasite 0.1.10

Data validation for Python 3

parasite v0.1.10

zod inspired library for Python 3.11+
Report Bug | Request Feature

[!WARNING]

This library is under active development, expect things to break or not to work as expected. Creating an issue for bugs you encounter would be appreciated. Documentation is currently work in progress.

Table of Contents

• Why?
• What about the name?
• Getting Started
  • Installing
  • Example usage
• Documentation
• Code Coverage
• License (MIT License)

Why?

Data and object validation in Python is essential to ensure that the inputs to a program are accurate and adhere to expected formats, thereby preventing runtime errors and enhancing code reliability. The TypeScript library zod offers a concise and expressive syntax for schema validation, making it easier to define and enforce data structures. Implementing a similar library in Python would greatly benefit developers by providing a streamlined, declarative approach to validation, reducing boilerplate code and improving maintainability. This would facilitate more robust data handling and enhance the overall quality of Python applications.

What about the name?

I chose the name "Parasite" for this library because it draws heavy inspiration from the TypeScript zod library, which excels in schema validation with its concise and expressive syntax. The name "Parasite" is also a nod to one of Superman's iconic supervillains, serving as an homage to the library that inspired this creation.

Getting Started

Installing

Install using pip:

pip install parasite

Install using poetry CLI:

poetry add parasite

or using pyproject.toml:

[tool.poetry.dependencies]
parasite = "^0.1.0"

Example usage

from parasite import p

schema = p.obj({
    "name": p.string().required(),
    "age": p.number().integer().min(0).optional(),
}).strip()

data = {
    "name": "John Doe",
    "age": 42,
    "extra": "This will be stripped",
}

schema.parse(data)   # {"name": "John Doe", "age": 42}
schema.parse({})   # ValidationError: Missing required key: "name"

Documentation

[!IMPORTANT]

You can find the sphinx online documentation here!

Code Coverage

---------- coverage: platform linux, python 3.11.9-final-0 -----------
Name                       Stmts   Miss  Cover
----------------------------------------------
src/parasite/__init__.py      22      0   100%
src/parasite/_const.py        17      0   100%
src/parasite/_utils.py         7      0   100%
src/parasite/any.py           27      0   100%
src/parasite/array.py         70      0   100%
src/parasite/boolean.py       72      0   100%
src/parasite/errors.py         1      0   100%
src/parasite/never.py         18      0   100%
src/parasite/null.py          29      0   100%
src/parasite/number.py       106      0   100%
src/parasite/object.py        93      0   100%
src/parasite/string.py       207      0   100%
src/parasite/type.py          29      0   100%
src/parasite/variant.py       61      0   100%
----------------------------------------------
TOTAL                        759      0   100%

License (MIT License)

Copyright (c) 2024, Hendrik Böck <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.