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

openepd/model/epd.py

@@ -13,8 +13,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
+import pydantic
 
-from openepd.compat.pydantic import pyd
 from openepd.model.base import BaseDocumentFactory, OpenEpdDoctypes, OpenEpdExtension
 from openepd.model.common import Ingredient, WithAltIdsMixin, WithAttachmentsMixin
 from openepd.model.declaration import (
@@ -73,50 +73,50 @@ class Ec3EpdExtension(OpenEpdExtension):
         """Return the name of the extension."""
         return "ec3"
 
-    uaGWP_a1a2a3_traci21: float | None = pyd.Field(
+    uaGWP_a1a2a3_traci21: float | None = pydantic.Field(
         default=None,
         description="""The A1A2A3 uncertainty-adjusted GWP, in kgCO2e per declared unit, calculated for the TRACI 2.1
         LCIA method. This is the value that should be used to compare EPDs against each other, or against an
         uncertainty-adjusted limit/benchmark, once both have been converted to the same declared unit. This is a
         materialized value provided for the convenience of integrators, and can be regenerated at any time from the
          specificity and EC3 category. The value is provided per comparison_unit.""",
-        example=22.5,
+        examples=[22.5],
     )
-    uaGWP_a1a2a3_ar5: float | None = pyd.Field(
+    uaGWP_a1a2a3_ar5: float | None = pydantic.Field(
         default=None,
         description="""The A1A2A3 uncertainty-adjusted GWP, calculated for the IPCC AR5 LCIA method. This is the value
         that should be used to compare EPDs against each other, or against an uncertainty-adjusted limit/benchmark,
         once both have been converted to the same declared unit. This is a materialized value, and can be regenerated
         at any time from the specificity and EC3 category.""",
-        example=22.5,
+        examples=[22.5],
     )
-    category: str | None = pyd.Field(
+    category: str | None = pydantic.Field(
         default=None,
         description="The category of the EPD in EC3 notation. Same as EC3 category from root EPD's product_classes for "
         "EC3.",
     )
-    manufacturer_specific: bool | None = pyd.Field(
+    manufacturer_specific: bool | None = pydantic.Field(
         default=None,
         description="""An EPD is Manufacturer Specific if it is based on data from a single manufacturer, as opposed
         to an industry group, sector, or generic process. This field should always be true for openEPD documents
         (as opposed to openIndustryEPDs).""",
     )
-    plant_specific: bool | None = pyd.Field(
+    plant_specific: bool | None = pydantic.Field(
         default=None,
         description="""An EPD is Product Specific if it is based on data regarding the specific product being
         delivered, as opposed to a range of products whose GWP per unit may vary by more than 10%.""",
     )
-    product_specific: bool | None = pyd.Field(
+    product_specific: bool | None = pydantic.Field(
         default=None,
         description="""An EPD is Product Specific if it is based on data regarding the specific product being
         delivered, as opposed to a range of products whose GWP per unit may vary by more than 10%.""",
     )
-    batch_specific: bool | None = pyd.Field(
+    batch_specific: bool | None = pydantic.Field(
         default=None,
         description="""An EPD is Product Specific if it is created with production data for a single production run of
          no more than 90 days. Typically these must be generated on a just-in-time or on-demand basis.""",
     )
-    supply_chain_specificity: float | None = pyd.Field(
+    supply_chain_specificity: float | None = pydantic.Field(
         default=None,
         description="""An EPD is Supply Chain Specific to the extent that impacts of process inputs are based on
         product-specific, facility-specific EPDs or third-party verified LCA for those inputs. For example, a concrete
@@ -124,7 +124,7 @@ class Ec3EpdExtension(OpenEpdExtension):
          have around 85% supply chain specificity.""",
     )
 
-    original_data_format: OriginalDataFormat | None = pyd.Field(default=None)
+    original_data_format: OriginalDataFormat | None = pydantic.Field(default=None)
 
 
 class EpdRef(RefBase, title="EPD (Ref)"):
@@ -151,29 +151,35 @@ class EpdPreviewV0(
 
     _FORMAT_VERSION = OpenEpdVersions.Version0.as_str()
 
-    doctype: str = pyd.Field(
+    doctype: str = pydantic.Field(
         description='Describes the type and schema of the document. Must always always read "openEPD".',
         default="openEPD",
     )
 
-    product_name: str | None = pyd.Field(
-        max_length=200, description="The name of the product described by this EPD", example="Mix 12345AC", default=None
+    product_name: str | None = pydantic.Field(
+        max_length=200,
+        description="The name of the product described by this EPD",
+        examples=["Mix 12345AC"],
+        default=None,
     )
-    product_sku: str | None = pyd.Field(
-        max_length=200, description="Unique stock keeping identifier assigned by manufacturer"
+    product_sku: str | None = pydantic.Field(
+        max_length=200,
+        description="Unique stock keeping identifier assigned by manufacturer",
+        default=None,
     )
-    product_description: str | None = pyd.Field(
+    product_description: str | None = pydantic.Field(
         max_length=2000,
         description="1-paragraph description of product. Supports plain text or github flavored markdown.",
+        default=None,
     )
-    manufacturer: Org | None = pyd.Field(description=MANUFACTURER_DESCRIPTION)
-    plants: list[Plant] = pyd.Field(
-        max_items=32,
+    manufacturer: Org | None = pydantic.Field(description=MANUFACTURER_DESCRIPTION, default=None)
+    plants: list[Plant] = pydantic.Field(
+        max_length=32,
         description=PLANT_DESCRIPTION,
         default_factory=list,
     )
 
-    annual_production: float | None = pyd.Field(
+    annual_production: float | None = pydantic.Field(
         gt=0,
         default=None,
         description="Approximate annual production volume, in declared units, of product covered by this EPD. "
@@ -181,10 +187,10 @@ class EpdPreviewV0(
         "Providing this data is optional, and it is acceptable to round or obfuscate it downwards "
         "(but not upwards) by any amount desired to protect confidentiality. For example, if the "
         "product volume is 123,456 m3, a value of 120,000, 100,000 or even 87,654 would be acceptable.",
-        example=10000,
+        examples=[10000],
     )
-    applicable_in: list[Geography] | None = pyd.Field(
-        max_items=100,
+    applicable_in: list[Geography] | None = pydantic.Field(
+        max_length=100,
         default=None,
         description="Jurisdiction(s) in which EPD is applicable. An empty array, or absent properties, "
         "implies global applicability. Accepts "
@@ -192,37 +198,39 @@ class EpdPreviewV0(
         "[M49 region codes](https://unstats.un.org/unsd/methodology/m49/), "
         'or the alias "EU27" for the 27 members of the Euro bloc, or the alias "NAFTA" '
         "for the members of North American Free Trade Agreement",
-        example=["US", "CA", "MX", "EU27", "NAFTA"],
+        examples=[["US", "CA", "MX", "EU27", "NAFTA"]],
     )
-    product_usage_description: str | None = pyd.Field(
+    product_usage_description: str | None = pydantic.Field(
         default=None,
         description="Text description of how product is typically used. Can be used to describe accessories "
         "like fasteners, adhesives, etc.  Supports plain text or github flavored markdown.",
     )
-    product_usage_image: pyd.AnyUrl | None = pyd.Field(
-        description="Pointer (url) to image illustrating how the product is used. No more than 10MB.", default=None
+    product_usage_image: pydantic.AnyUrl | None = pydantic.Field(
+        description="Pointer (url) to image illustrating how the product is used. No more than 10MB.",
+        default=None,
     )
-    manufacturing_description: str | None = pyd.Field(
+    manufacturing_description: str | None = pydantic.Field(
         default=None,
         description="Text description of manufacturing process.  Supports plain text or github flavored markdown.",
     )
-    manufacturing_image: pyd.AnyUrl | None = pyd.Field(
-        description="Pointer (url) to an image illustrating the manufacturing process. No more than 10MB.", default=None
+    manufacturing_image: pydantic.AnyUrl | None = pydantic.Field(
+        description="Pointer (url) to an image illustrating the manufacturing process. No more than 10MB.",
+        default=None,
     )
 
-    specs: Specs = pyd.Field(
+    specs: Specs = pydantic.Field(
         default_factory=Specs,
         description="Data structure(s) describing performance specs of product. Unique for each material type.",
     )
-    includes: list[Ingredient] = pyd.Field(
-        max_items=255,
+    includes: list[Ingredient] = pydantic.Field(
+        max_length=255,
         description="List of JSON objects pointing to product components. "
         "Each one should be an EPD or digitized LCI process.",
         default_factory=list,
     )
-    ec3: Ec3EpdExtension | None = pyd.Field(default=None, description="EC3-specific EPD extension.")
+    ec3: Ec3EpdExtension | None = pydantic.Field(default=None, description="EC3-specific EPD extension.")
 
-    @pyd.validator("doctype")
+    @pydantic.field_validator("doctype", mode="before")
     def validate_doctype(cls, v: str | None) -> str:
         """
         Handle possible mixed case options for doctype.
@@ -247,14 +255,14 @@ class EpdV0(WithLciaMixin, EpdPreviewV0, title="EPD (Full)"):
         """Return the asset type of this class (see BaseOpenEpdSchema.get_asset_type for details)."""
         return "epd"
 
-    @pyd.validator("compliance", always=True, pre=True)
+    @pydantic.field_validator("compliance", mode="before")
     def validate_compliance(cls, v: list | None):
         """Handle correctly None values for compliance field."""
         if v is None:
             return []
         return v
 
-    @pyd.validator("includes", always=True, pre=True)
+    @pydantic.field_validator("includes", mode="before")
     def validate_includes(cls, v: list | None):
         """Handle correctly None values for includes field."""
         if v is None:
@@ -274,10 +282,10 @@ class EpdWithDepsV0(EpdV0, title="EPD (with Dependencies)"):
     some required fields in Org (like web_domain), and WithDeps would not.
     """
 
-    manufacturer: Org | None = pyd.Field(description=MANUFACTURER_DESCRIPTION)
-    epd_developer: Org | None = pyd.Field(description=DEVELOPER_DESCRIPTION, default=None)
-    program_operator: Org | None = pyd.Field(description=PROGRAM_OPERATOR_DESCRIPTION)
-    third_party_verifier: Org | None = pyd.Field(description=THIRD_PARTY_VERIFIER_DESCRIPTION)
+    manufacturer: Org | None = pydantic.Field(description=MANUFACTURER_DESCRIPTION)
+    epd_developer: Org | None = pydantic.Field(description=DEVELOPER_DESCRIPTION, default=None)
+    program_operator: Org | None = pydantic.Field(description=PROGRAM_OPERATOR_DESCRIPTION)
+    third_party_verifier: Org | None = pydantic.Field(description=THIRD_PARTY_VERIFIER_DESCRIPTION)
 
 
 EpdWithDeps = EpdWithDepsV0

openepd/model/generic_estimate.py

@@ -16,7 +16,8 @@
 from enum import StrEnum
 from typing import Literal
 
-from openepd.compat.pydantic import pyd
+import pydantic
+
 from openepd.model.base import BaseDocumentFactory, OpenEpdDoctypes
 from openepd.model.common import WithAltIdsMixin, WithAttachmentsMixin
 from openepd.model.declaration import AverageDatasetMixin, BaseDeclaration, RefBase
@@ -51,7 +52,11 @@ class GenericEstimateRef(RefBase, title="Generic Estimate (Ref)"):
 
 
 class GenericEstimatePreviewV0(
-    WithAttachmentsMixin, AverageDatasetMixin, GenericEstimateRef, BaseDeclaration, title="Generic Estimate (preview)"
+    WithAttachmentsMixin,
+    AverageDatasetMixin,
+    GenericEstimateRef,
+    BaseDeclaration,
+    title="Generic Estimate (preview)",
 ):
     """
     Generic Estimate preview, used in API list responses and where there is no need for a full object.
@@ -61,27 +66,37 @@ class GenericEstimatePreviewV0(
 
     _FORMAT_VERSION = OpenEpdVersions.Version0.as_str()
 
-    doctype: Literal["openGenericEstimate"] = pyd.Field(
+    doctype: Literal["openGenericEstimate"] = pydantic.Field(
         description='Describes the type and schema of the document. Must always be "openGenericEstimate"',
         default="openGenericEstimate",
     )
 
-    publisher: Org | None = pyd.Field(description="Organization that published the LCA results.")
-    reviewer: Org | None = pyd.Field(description="Org that performed a critical review of the LCA.")
-    reviewer_email: pyd.EmailStr | None = pyd.Field(
-        description="Email address of the third party verifier", example="john.doe@example.com", default=None
+    publisher: Org | None = pydantic.Field(description="Organization that published the LCA results.", default=None)
+    reviewer: Org | None = pydantic.Field(description="Org that performed a critical review of the LCA.", default=None)
+    reviewer_email: pydantic.EmailStr | None = pydantic.Field(
+        description="Email address of the third party verifier",
+        examples=["john.doe@example.com"],
+        default=None,
     )
 
-    license_terms: LicenseTerms | None = pyd.Field(description="The license terms for use of the data.")
-    model_repository: pyd.AnyUrl | None = pyd.Field(
-        default=None, description="A link to the shared git repository containing the LCA model used for this estimate."
+    license_terms: LicenseTerms | None = pydantic.Field(
+        description="The license terms for use of the data.", default=None
+    )
+    model_repository: pydantic.AnyUrl | None = pydantic.Field(
+        default=None,
+        description="A link to the shared git repository containing the LCA model used for this estimate.",
     )
 
 
 GenericEstimatePreview = GenericEstimatePreviewV0
 
 
-class GenericEstimateV0(GenericEstimatePreviewV0, WithLciaMixin, WithAltIdsMixin, title="Generic Estimate (Full)"):
+class GenericEstimateV0(
+    GenericEstimatePreviewV0,
+    WithLciaMixin,
+    WithAltIdsMixin,
+    title="Generic Estimate (Full)",
+):
     """Full Generic Estimate object."""
 
 
@@ -95,8 +110,8 @@ class GenericEstimateWithDepsV0(GenericEstimateV0, title="Generic Estimate (with
     Contains related entities - orgs - with full fields, to support object matching in implementations.
     """
 
-    publisher: Org | None = pyd.Field(description="Organization that published the LCA results.")
-    reviewer: Org | None = pyd.Field(description="Org that performed a critical review of the LCA.")
+    publisher: Org | None = pydantic.Field(description="Organization that published the LCA results.")
+    reviewer: Org | None = pydantic.Field(description="Org that performed a critical review of the LCA.")
 
 
 GenericEstimateWithDeps = GenericEstimateWithDepsV0

openepd/model/industry_epd.py

@@ -15,7 +15,8 @@
 #
 from typing import Literal
 
-from openepd.compat.pydantic import pyd
+import pydantic
+
 from openepd.model.base import BaseDocumentFactory, BaseOpenEpdSchema, OpenEpdDoctypes
 from openepd.model.common import WithAltIdsMixin, WithAttachmentsMixin
 from openepd.model.declaration import (
@@ -34,16 +35,21 @@ from openepd.model.versioning import OpenEpdVersions, Version
 class SampleSize(BaseOpenEpdSchema):
     """Sample size."""
 
-    products: pyd.NonNegativeInt | None = pyd.Field(
+    products: int | None = pydantic.Field(
         default=None,
         description="Count of separate products or results that were included in this industry EPD, "
         "and over which the standard deviation was calculated",
+        ge=0,
     )
-    plants: pyd.NonNegativeInt | None = pyd.Field(
-        default=None, description="Count of unique manufacturing plants that submitted data for this Industry EPD"
+    plants: int | None = pydantic.Field(
+        default=None,
+        description="Count of unique manufacturing plants that submitted data for this Industry EPD",
+        ge=0,
     )
-    manufacturers: pyd.NonNegativeInt | None = pyd.Field(
-        default=None, description="Count of unique manufacturing companies that submitted data for this Industry EPD"
+    manufacturers: int | None = pydantic.Field(
+        default=None,
+        description="Count of unique manufacturing companies that submitted data for this Industry EPD",
+        ge=0,
     )
 
 
@@ -69,15 +75,15 @@ class IndustryEpdPreviewV0(
 
     _FORMAT_VERSION = OpenEpdVersions.Version0.as_str()
 
-    doctype: Literal["openIndustryEpd"] = pyd.Field(
+    doctype: Literal["openIndustryEpd"] = pydantic.Field(
         description='Describes the type and schema of the document. Must always be "openIndustryEpd"',
         default="openIndustryEpd",
     )
 
     sample_size: SampleSize | None = None
 
-    publishers: list[Org] | None = pyd.Field(description="")
-    manufacturers: list[Org] | None = pyd.Field(description="Participating manufacturers")
+    publishers: list[Org] | None = pydantic.Field(description="", default=None)
+    manufacturers: list[Org] | None = pydantic.Field(description="Participating manufacturers", default=None)
 
 
 IndustryEpdPreview = IndustryEpdPreviewV0