feat: Added PydanticPintQuantity as an option to enforce unit validation for fields

[pesap]

This was the original idea we intended before introducing BaseQuantity. It is more simple, but in the same spirt that we add an annotation as to enforce the unit as follow:

from typing import Annotated
from pint import Quantity
from infrasys.component import Component
from infrasys.pint_quantities import PydanticPintQuantity

class ACBus(Component):
    voltage: Annotated[Quantity, PydanticPintQuantity("volts")]

I do not plan to retire the BaseQuantity from infrasys, but this could be a simplier solution for people that do not want to create a class that enforces unit validation.

Someone already released this as a package here: https://github.com/tylerh111/pydantic-pint. We do not need the full implementation or dependency since we already had something similar.

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 96.19048% with 4 lines in your changes missing coverage. Please review.

Project coverage is 96.06%. Comparing base (420e7d0) to head (644a266).

Files with missing lines	Patch %	Lines
src/infrasys/pint_quantities.py	90.69%	4 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##             main      #56    +/-   ##
========================================
  Coverage   96.06%   96.06%            
========================================
  Files          34       36     +2     
  Lines        2871     2976   +105     
========================================
+ Hits         2758     2859   +101     
- Misses        113      117     +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[KapilDuwadi]

@pesap I like the general idea. Is there a way to make it easier to ensure value must be positive, nonnegative, nonpositive etc. ?

Currently we are defining positive resistance class like below. I was wondering how would we migrate this to your new implementation.

class PositiveResistance(Resistance):
    """Quantity representing power system resistance."""

    def __init__(self, value, units, **kwargs):
        assert value >= 0, f"Resistance ({value}, {units}) must be positive."

[pesap]

@pesap I like the general idea. Is there a way to make it easier to ensure value must be positive, nonnegative, nonpositive etc. ?

Currently we are defining positive resistance class like below. I was wondering how would we migrate this to your new implementation.

class PositiveResistance(Resistance):
    """Quantity representing power system resistance."""

    def __init__(self, value, units, **kwargs):
        assert value >= 0, f"Resistance ({value}, {units}) must be positive."

Yes, @KapilDuwadi . You can compose constraints. Using your example it would look like this,

from typing import Annotated
from pint import Quantity
from pydantic import Field
from infrasys.component import Component
from infrasys.pint_quantities import PydanticPintQuantity

class ACBus(Component):
    resistance: Annotated[Quantity, PydanticPintQuantity("ohms"), Field(gt=0)]

[daniel-thom]

This seems convenient, but I'm not completely following. It is being set per instance. Would the user set it after construction?

[pesap]

Yea after construction. We can remove it if we do not need it. It mostly import for serialization. Can we replace some of our logic here?

[daniel-thom]

Let's discuss it.

[pesap]

Shall we raise this to an issue?

[KapilDuwadi]

@pesap I like the general idea. Is there a way to make it easier to ensure value must be positive, nonnegative, nonpositive etc. ?
Currently we are defining positive resistance class like below. I was wondering how would we migrate this to your new implementation.

class PositiveResistance(Resistance):
    """Quantity representing power system resistance."""

    def __init__(self, value, units, **kwargs):
        assert value >= 0, f"Resistance ({value}, {units}) must be positive."

Yes, @KapilDuwadi . You can compose constraints. Using your example it would look like this,

from typing import Annotated
from pint import Quantity
from pydantic import Field
from infrasys.component import Component
from infrasys.pint_quantities import PydanticPintQuantity

class ACBus(Component):
    resistance: Annotated[Quantity, PydanticPintQuantity("ohms"), Field(gt=0)]

Cool makes sense.