openepd 6.13.2__py3-none-any.whl → 7.0.1__py3-none-any.whl

openepd/model/specs/singular/thermal_moisture_protection.py

@@ -13,7 +13,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
-from openepd.compat.pydantic import pyd
+import pydantic
+
 from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
 from openepd.model.specs.enums import (
     FoamType,
@@ -23,7 +24,6 @@ from openepd.model.specs.enums import (
     RoofCoverBoardsFacing,
     RoofCoverBoardsMaterial,
 )
-from openepd.model.validation.numbers import RatioFloat
 from openepd.model.validation.quantity import LengthMmStr, PressureMPaStr
 
 
@@ -95,7 +95,7 @@ class BoardInsulationV1(BaseOpenEpdHierarchicalSpec):
     _EXT_VERSION = "1.0"
 
     # Own fields:
-    compressive_strength: PressureMPaStr | None = pyd.Field(default=None, description="", example="1 MPa")
+    compressive_strength: PressureMPaStr | None = pydantic.Field(default=None, description="", examples=["1 MPa"])
 
 
 class FoamedInPlaceV1(BaseOpenEpdHierarchicalSpec):
@@ -104,7 +104,7 @@ class FoamedInPlaceV1(BaseOpenEpdHierarchicalSpec):
     _EXT_VERSION = "1.0"
 
     # Own fields:
-    foam_type: FoamType | None = pyd.Field(default=None, description="", example="Open-Cell")
+    foam_type: FoamType | None = pydantic.Field(default=None, description="", examples=["Open-Cell"])
 
 
 class SprayedInsulationV1(BaseOpenEpdHierarchicalSpec):
@@ -134,14 +134,30 @@ class MembraneRoofingV1(BaseOpenEpdHierarchicalSpec):
     _EXT_VERSION = "1.0"
 
     # Own fields:
-    thickness: LengthMmStr | None = pyd.Field(default=None, description="", example="10 mm")
-    sri: float | None = pyd.Field(default=None, description="", example=2.3)
-    total_recycled_content: RatioFloat | None = pyd.Field(default=None, description="", example=0.5, ge=0, le=1)
-    post_consumer_recycled_content: RatioFloat | None = pyd.Field(default=None, description="", example=0.5, ge=0, le=1)
-    reinforcement: MembraneRoofingReinforcement | None = pyd.Field(default=None, description="", example="Polyester")
-    felt_backing: bool | None = pyd.Field(default=None, description="", example=True)
-    nsf347: bool | None = pyd.Field(default=None, description="", example=True)
-    vantage_vinyl: bool | None = pyd.Field(default=None, description="", example=True)
+    thickness: LengthMmStr | None = pydantic.Field(default=None, description="", examples=["10 mm"])
+    sri: float | None = pydantic.Field(default=None, description="", examples=[2.3])
+    total_recycled_content: float | None = pydantic.Field(default=None, description="", examples=[0.5], ge=0, le=1)
+    post_consumer_recycled_content: float | None = pydantic.Field(
+        default=None, description="", examples=[0.5], ge=0, le=1
+    )
+    reinforcement: MembraneRoofingReinforcement | None = pydantic.Field(
+        default=None, description="", examples=["Polyester"]
+    )
+    felt_backing: bool | None = pydantic.Field(
+        default=None,
+        description="",
+        examples=[True],
+    )
+    nsf347: bool | None = pydantic.Field(
+        default=None,
+        description="",
+        examples=[True],
+    )
+    vantage_vinyl: bool | None = pydantic.Field(
+        default=None,
+        description="",
+        examples=[True],
+    )
 
     # Nested specs:
     BituminousRoofing: BituminousRoofingV1 | None = None
@@ -159,12 +175,12 @@ class InsulationV1(BaseOpenEpdHierarchicalSpec):
     _EXT_VERSION = "1.0"
 
     # Own fields:
-    r_value: float | None = pyd.Field(default=None, description="", example=2.3)
-    material: InsulatingMaterial | None = pyd.Field(default=None, description="", example="Mineral Wool")
-    intended_application: list[InsulationIntendedApplication] | None = pyd.Field(
-        default=None, description="", example=["Wall & General"]
+    r_value: float | None = pydantic.Field(default=None, description="", examples=[2.3])
+    material: InsulatingMaterial | None = pydantic.Field(default=None, description="", examples=["Mineral Wool"])
+    intended_application: list[InsulationIntendedApplication] | None = pydantic.Field(
+        default=None, description="", examples=[["Wall & General"]]
     )
-    thickness_per_declared_unit: LengthMmStr | None = pyd.Field(default=None, description="", example="10 mm")
+    thickness_per_declared_unit: LengthMmStr | None = pydantic.Field(default=None, description="", examples=["10 mm"])
 
     # Nested specs:
     BlanketInsulation: BlanketInsulationV1 | None = None
@@ -207,9 +223,9 @@ class RoofCoverBoardsV1(BaseOpenEpdHierarchicalSpec):
     _EXT_VERSION = "1.0"
 
     # Own fields:
-    material: RoofCoverBoardsMaterial | None = pyd.Field(default=None, description="", example="Gypsum Fiber")
-    facing: list[RoofCoverBoardsFacing] | None = pyd.Field(default=None, description="", example=["Paper"])
-    thickness: LengthMmStr | None = pyd.Field(default=None, description="", example="1 m")
+    material: RoofCoverBoardsMaterial | None = pydantic.Field(default=None, description="", examples=["Gypsum Fiber"])
+    facing: list[RoofCoverBoardsFacing] | None = pydantic.Field(default=None, description="", examples=[["Paper"]])
+    thickness: LengthMmStr | None = pydantic.Field(default=None, description="", examples=["1 m"])
 
 
 class SteepSlopeRoofingV1(BaseOpenEpdHierarchicalSpec):

openepd/model/specs/singular/utility_piping.py

@@ -13,7 +13,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
-from openepd.compat.pydantic import pyd
+import pydantic
+
 from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
 from openepd.model.specs.enums import BuriedPipingType, PipingAnsiSchedule, UtilityPipingMaterial
 from openepd.model.validation.quantity import LengthMmStr, MassPerLengthStr
@@ -36,8 +37,8 @@ class BuriedPipingV1(BaseOpenEpdHierarchicalSpec):
     _EXT_VERSION = "1.0"
 
     # Own fields:
-    buried_piping_type: list[BuriedPipingType] | None = pyd.Field(
-        default=None, description="", example=["Water Utilities"]
+    buried_piping_type: list[BuriedPipingType] | None = pydantic.Field(
+        default=None, description="", examples=[["Water Utilities"]]
     )
 
 
@@ -52,11 +53,13 @@ class UtilityPipingV1(BaseOpenEpdHierarchicalSpec):
     _EXT_VERSION = "1.0"
 
     # Own fields:
-    thickness: LengthMmStr | None = pyd.Field(default=None, description="", example="6 m")
-    piping_diameter: LengthMmStr | None = pyd.Field(default=None, description="", example="200 mm")
-    mass_per_unit_length: MassPerLengthStr | None = pyd.Field(default=None, description="", example="1 kg / m")
-    piping_ansi_schedule: PipingAnsiSchedule | None = pyd.Field(default=None, description="", example="5")
-    utility_piping_material: UtilityPipingMaterial | None = pyd.Field(default=None, description="", example="PVC")
+    thickness: LengthMmStr | None = pydantic.Field(default=None, description="", examples=["6 m"])
+    piping_diameter: LengthMmStr | None = pydantic.Field(default=None, description="", examples=["200 mm"])
+    mass_per_unit_length: MassPerLengthStr | None = pydantic.Field(default=None, description="", examples=["1 kg / m"])
+    piping_ansi_schedule: PipingAnsiSchedule | None = pydantic.Field(default=None, description="", examples=["5"])
+    utility_piping_material: UtilityPipingMaterial | None = pydantic.Field(
+        default=None, description="", examples=["PVC"]
+    )
 
     # Nested specs:
     BuildingHeatingPiping: BuildingHeatingPipingV1 | None = None

openepd/model/specs/singular/wood.py

@@ -15,7 +15,8 @@
 #
 from typing import Annotated
 
-from openepd.compat.pydantic import pyd
+import pydantic
+
 from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec, CodegenSpec
 from openepd.model.specs.enums import (
     AllFabrication,
@@ -27,7 +28,6 @@ from openepd.model.specs.enums import (
     SheathingPanelsFabrication,
 )
 from openepd.model.specs.singular.common import HasForestPracticesCertifiers
-from openepd.model.validation.numbers import RatioFloat
 from openepd.model.validation.quantity import LengthMmStr
 
 
@@ -72,8 +72,10 @@ class CompositeLumberV1(BaseOpenEpdHierarchicalSpec):
 
     _EXT_VERSION = "1.0"
 
-    fabrication: CompositeLumberFabrication | None = pyd.Field(default=None, description="", example="LVL")
-    timber_species: EngineeredTimberSpecies | None = pyd.Field(default=None, description="", example="Alaska Cedar")
+    fabrication: CompositeLumberFabrication | None = pydantic.Field(default=None, description="", examples=["LVL"])
+    timber_species: EngineeredTimberSpecies | None = pydantic.Field(
+        default=None, description="", examples=["Alaska Cedar"]
+    )
 
 
 class DimensionLumberV1(BaseOpenEpdHierarchicalSpec):
@@ -82,7 +84,7 @@ class DimensionLumberV1(BaseOpenEpdHierarchicalSpec):
     _EXT_VERSION = "1.0"
 
     # Nested specs:
-    timber_species: SawnTimberSpecies | None = pyd.Field(default=None, description="", example="Alaska Cedar")
+    timber_species: SawnTimberSpecies | None = pydantic.Field(default=None, description="", examples=["Alaska Cedar"])
     WoodDecking: WoodDeckingV1 | None = None
     WoodFraming: WoodFramingV1 | None = None
 
@@ -103,8 +105,10 @@ class MassTimberV1(BaseOpenEpdHierarchicalSpec):
 
     _EXT_VERSION = "1.0"
 
-    fabrication: MassTimberFabrication | None = pyd.Field(default=None, description="", example="CLT")
-    timber_species: EngineeredTimberSpecies | None = pyd.Field(default=None, description="", example="Alaska Cedar")
+    fabrication: MassTimberFabrication | None = pydantic.Field(default=None, description="", examples=["CLT"])
+    timber_species: EngineeredTimberSpecies | None = pydantic.Field(
+        default=None, description="", examples=["Alaska Cedar"]
+    )
 
 
 class NonStructuralWoodV1(BaseOpenEpdHierarchicalSpec):
@@ -134,9 +138,11 @@ class SheathingPanelsV1(BaseOpenEpdHierarchicalSpec):
     _EXT_VERSION = "1.0"
 
     # Own fields:
-    fabrication: SheathingPanelsFabrication | None = pyd.Field(default=None, description="", example="Plywood")
-    wood_board_thickness: LengthMmStr | None = pyd.Field(default=None, description="", example="10 mm")
-    timber_species: EngineeredTimberSpecies | None = pyd.Field(default=None, description="", example="Alaska Cedar")
+    fabrication: SheathingPanelsFabrication | None = pydantic.Field(default=None, description="", examples=["Plywood"])
+    wood_board_thickness: LengthMmStr | None = pydantic.Field(default=None, description="", examples=["10 mm"])
+    timber_species: EngineeredTimberSpecies | None = pydantic.Field(
+        default=None, description="", examples=["Alaska Cedar"]
+    )
 
 
 class UnfinishedWoodV1(BaseOpenEpdHierarchicalSpec):
@@ -151,25 +157,43 @@ class WoodV1(BaseOpenEpdHierarchicalSpec, HasForestPracticesCertifiers):
     _EXT_VERSION = "1.0"
 
     # Own fields:
-    timber_species: AllTimberSpecies | None = pyd.Field(
-        default=None, description="Timber species", example="Alaska Cedar"
+    timber_species: AllTimberSpecies | None = pydantic.Field(
+        default=None, description="Timber species", examples=["Alaska Cedar"]
+    )
+    fabrication: AllFabrication | None = pydantic.Field(
+        default=None, description="Timber fabrication", examples=["LVL"]
+    )
+    weather_exposed: bool | None = pydantic.Field(
+        default=None,
+        description="Weather exposed",
+        examples=[True],
+    )
+    fire_retardant: bool | None = pydantic.Field(
+        default=None,
+        description="Fire retardant",
+        examples=[True],
+    )
+    decay_resistant: bool | None = pydantic.Field(
+        default=None,
+        description="Decay resistant",
+        examples=[True],
     )
-    fabrication: AllFabrication | None = pyd.Field(default=None, description="Timber fabrication", example="LVL")
-    weather_exposed: bool | None = pyd.Field(default=None, description="Weather exposed", example=True)
-    fire_retardant: bool | None = pyd.Field(default=None, description="Fire retardant", example=True)
-    decay_resistant: bool | None = pyd.Field(default=None, description="Decay resistant", example=True)
-    fsc_certified: Annotated[RatioFloat | None, CodegenSpec(override_type=RatioFloat)] = pyd.Field(
-        default=None, description="Forest Stewardship Council certified proportion", example=0.3, ge=0, le=1
+    fsc_certified: Annotated[float | None, CodegenSpec(override_type=float)] = pydantic.Field(
+        default=None,
+        description="Forest Stewardship Council certified proportion",
+        examples=[0.3],
+        ge=0,
+        le=1,
     )
-    fsc_certified_z: Annotated[float | None, CodegenSpec(override_type=float)] = pyd.Field(
-        default=None, description="", example=0.7
+    fsc_certified_z: Annotated[float | None, CodegenSpec(override_type=float)] = pydantic.Field(
+        default=None, description="", examples=[0.7]
     )
 
-    recycled_content: Annotated[RatioFloat | None, CodegenSpec(override_type=RatioFloat)] = pyd.Field(
-        default=None, description="Recycled content", example=0.3, ge=0, le=1
+    recycled_content: Annotated[float | None, CodegenSpec(override_type=float)] = pydantic.Field(
+        default=None, description="Recycled content", examples=[0.3], ge=0, le=1
     )
-    recycled_content_z: Annotated[float | None, CodegenSpec(override_type=float)] = pyd.Field(
-        default=None, description="", example=0.7
+    recycled_content_z: Annotated[float | None, CodegenSpec(override_type=float)] = pydantic.Field(
+        default=None, description="", examples=[0.7]
     )
 
     # Nested specs:

openepd/model/specs/singular/wood_joists.py

@@ -13,7 +13,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
-from openepd.compat.pydantic import pyd
+import pydantic
+
 from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
 from openepd.model.specs.enums import AllFabrication, AllTimberSpecies
 from openepd.model.specs.singular.common import HasForestPracticesCertifiers
@@ -30,8 +31,20 @@ class WoodJoistsV1(BaseOpenEpdHierarchicalSpec, HasForestPracticesCertifiers):
     _EXT_VERSION = "1.0"
 
     # Own fields:
-    timber_species: AllTimberSpecies | None = pyd.Field(default=None, description="", example="Alaska Cedar")
-    fabrication: AllFabrication | None = pyd.Field(default=None, description="", example="LVL")
-    weather_exposed: bool | None = pyd.Field(default=None, description="", example=True)
-    fire_retardant: bool | None = pyd.Field(default=None, description="", example=True)
-    decay_resistant: bool | None = pyd.Field(default=None, description="", example=True)
+    timber_species: AllTimberSpecies | None = pydantic.Field(default=None, description="", examples=["Alaska Cedar"])
+    fabrication: AllFabrication | None = pydantic.Field(default=None, description="", examples=["LVL"])
+    weather_exposed: bool | None = pydantic.Field(
+        default=None,
+        description="",
+        examples=[True],
+    )
+    fire_retardant: bool | None = pydantic.Field(
+        default=None,
+        description="",
+        examples=[True],
+    )
+    decay_resistant: bool | None = pydantic.Field(
+        default=None,
+        description="",
+        examples=[True],
+    )

openepd/model/standard.py

@@ -13,7 +13,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
-from openepd.compat.pydantic import pyd
+import pydantic
+
 from openepd.model.base import BaseOpenEpdSchema
 from openepd.model.org import OrgRef
 from openepd.model.validation.common import ReferenceStr
@@ -22,19 +23,25 @@ from openepd.model.validation.common import ReferenceStr
 class StandardRef(BaseOpenEpdSchema):
     """Reference version (short) of Standard."""
 
-    ref: ReferenceStr | None = pyd.Field(
+    ref: ReferenceStr | None = pydantic.Field(
         default=None,
-        example="https://openepd.buildingtransparency.org/api/standards/EN15804",
+        examples=["https://openepd.buildingtransparency.org/api/standards/EN15804"],
         description="Reference to this Standard's JSON object",
     )
-    short_name: str | None = pyd.Field(description="Short-form of name of standard.  Must be unique. Case-insensitive")
+    short_name: str | None = pydantic.Field(
+        description="Short-form of name of standard.  Must be unique. Case-insensitive"
+    )
 
 
 class Standard(StandardRef):
     """A standard, such as EN 15804, ISO 14044, ISO 14024:2018, etc."""
 
-    name: str | None = pyd.Field(description="Full document name.  Must be unique. Case-insensitive", default=None)
-    link: pyd.AnyUrl | None = pyd.Field(
-        description="Link to the exact standard (including version) referred to", default=None
+    name: str | None = pydantic.Field(
+        description="Full document name.  Must be unique. Case-insensitive",
+        default=None,
+    )
+    link: pydantic.AnyUrl | None = pydantic.Field(
+        description="Link to the exact standard (including version) referred to",
+        default=None,
     )
-    issuer: OrgRef | None = pyd.Field(description="Org that issued this standard", default=None)
+    issuer: OrgRef | None = pydantic.Field(description="Org that issued this standard", default=None)

openepd/model/validation/common.py

@@ -15,7 +15,8 @@
 #
 from typing import Annotated, Any, Callable, Type, TypeAlias
 
-from openepd.compat.pydantic import pyd
+import pydantic
+
 from openepd.model.versioning import Version
 
 
@@ -33,7 +34,9 @@ def validate_version_format(v: str) -> str:
     return v
 
 
-def validate_version_compatibility(class_version_attribute_name: str) -> Callable[[Type, str], str]:
+def validate_version_compatibility(
+    class_version_attribute_name: str,
+) -> Callable[[Type, str], str]:
     """Ensure that the object which is passed for parsing and validation is compatible with the class."""
 
     # we need closure to pass property name, since actual class will only be available in runtime
@@ -51,5 +54,8 @@ def validate_version_compatibility(class_version_attribute_name: str) -> Callabl
 
 ReferenceStr: TypeAlias = Annotated[
     str,
-    pyd.Field(description="Reference to another object", example="https://buildingtransparency.org/ec3/epds/1u7zsed8"),
+    pydantic.Field(
+        description="Reference to another object",
+        examples=["https://buildingtransparency.org/ec3/epds/1u7zsed8"],
+    ),
 ]

openepd/model/validation/numbers.py

@@ -13,16 +13,3 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
-
-
-# todo when move to pydantic 2, these should change to Annotated[float, ...]
-class RatioFloat(float):
-    """Float representing a ratio (0-1)."""
-
-    pass
-
-
-class PositiveInt(int):
-    """Greater than zero integer."""
-
-    pass