pydantic-pint 0.1

Description:

pydanticpint 0.1

Pydantic Pint





Pydantic is a Python library for data validation and data serialization.
Pint is a Python library for defining, operating, and manipulating physical quantities.
By default, they do not play well with each other.
Many projects that have a need for data validation may also need to work with physical quantities.
Pydantic Pint aims to bridge that gap by providing Pydantic validation for Pint quantities.
from pydantic import BaseModel
from pydantic_pint import PydanticPintQuantity
from pint import Quantity
from typing import Annotations

class Box(BaseModel):
length: Annotated[Quantity, PydanticPintQuantity("m")]
width: Annotated[Quantity, PydanticPintQuantity("m")]

box = Box(
length="4m",
width="2m",
)

Getting Started
Installation
Pydantic Pint is available as pydantic-pint on PyPI.
Pydantic Pint requires both Pydantic and Pint to be installed.
It also requires typing.Annotated (for older version of python use typing-extensions).
pip install pydantic-pint

Usage
Pydantic Pint provides PydanticPintQuantity which enabled Pydantic validation for Pint quantities.
For a field of a Pydantic model to have quantity validation, it must be annotated with a PydanticPintQuantity for a given unit.
from pydantic import BaseModel
from pydantic_pint import PydanticPintQuantity
from pint import Quantity
from typing import Annotated

class Coordinates(BaseModel):
latitude: Annotated[Quantity, PydanticPintQuantity("deg")]
longitude: Annotated[Quantity, PydanticPintQuantity("deg")]
altitude: Annotated[Quantity, PydanticPintQuantity("km")]

Users of the model can input anything to the field with a specified unit that is convertible to the units declared in the annotation.
For instance, the units for Coordinates.altitude are kilometers, however users can specify meters instead.
PydanticPintQuantity will handle the conversion from meters to kilometers.
coord = Coordinates(
latitude="39.905705 deg",
longitude="-75.166519 deg",
altitude="12 meters",
)

print(coord)
#> latitude=<Quantity(39.905705, 'degree')> longitude=<Quantity(-75.166519, 'degree')> altitude=<Quantity(0.012, 'kilometer')>
print(f"{coord!r}")
#> Coordinates(latitude=<Quantity(39.905705, 'degree')>, longitude=<Quantity(-75.166519, 'degree')>, altitude=<Quantity(0.012, 'kilometer')>)
print(coord.model_dump())
#> {'latitude': <Quantity(39.905705, 'degree')>, 'longitude': <Quantity(-75.166519, 'degree')>, 'altitude': <Quantity(0.012, 'kilometer')>}
print(coord.model_dump(mode="json"))
#> {'latitude': '39.905705 degree', 'longitude': '-75.166519 degree', 'altitude': '0.012 kilometer'}
print(f"{coord.model_dump_json()!r}")
#> '{"latitude":"39.905705 degree","longitude":"-75.166519 degree","altitude":"0.012 kilometer"}'