openepd 4.12.0__tar.gz → 4.13.0__tar.gz

{openepd-4.12.0 → openepd-4.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openepd
-Version: 4.12.0
+Version: 4.13.0
 Summary: Python library to work with OpenEPD format
 Home-page: https://github.com/cchangelabs/openepd
 License: Apache-2.0

{openepd-4.12.0 → openepd-4.13.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openepd"
-version = "4.12.0"
+version = "4.13.0"
 license = "Apache-2.0"
 description = "Python library to work with OpenEPD format"
 authors = ["C-Change Labs <support@c-change-labs.com>"]
@@ -37,6 +37,7 @@ pytest-subtests = "~=0.4"
 pytest-cov = "~=4.0"
 teamcity-messages = ">=1.31"
 wheel = "~=0.40.0"
+open-xpd-uuid = "~=0.2.1"
 
 # Dev tools
 black = "~=24.3"

{openepd-4.12.0 → openepd-4.13.0}/src/openepd/__version__.py

@@ -13,4 +13,4 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
-VERSION = "4.12.0"
+VERSION = "4.13.0"

{openepd-4.12.0 → openepd-4.13.0}/src/openepd/model/base.py

@@ -18,6 +18,8 @@ from enum import StrEnum
 import json
 from typing import Any, Callable, ClassVar, Generic, Optional, Type, TypeAlias, TypeVar
 
+from cqd import open_xpd_uuid  # type:ignore[import-untyped]
+
 from openepd.compat.pydantic import pyd, pyd_generics
 from openepd.model.validation.common import validate_version_compatibility, validate_version_format
 from openepd.model.versioning import OpenEpdVersions, Version
@@ -233,3 +235,31 @@ class BaseDocumentFactory(Generic[TRootDocument]):
                     )
         supported_versions = ", ".join(f"{v.major}.x" for v in cls.VERSION_MAP.keys())
         raise ValueError(f"Version {version} is not supported. Supported versions are: {supported_versions}")
+
+
+class OpenXpdUUID(str):
+    """
+    An open xpd UUID format for IDs of openEPD documents.
+
+    See https://github.com/cchangelabs/open-xpd-uuid-lib for details.
+    """
+
+    def _validate_id(cls, v: str | None) -> str | None:
+        if v is None:
+            return v
+
+        try:
+            open_xpd_uuid.validate(open_xpd_uuid.sanitize(str(v)))
+            return v
+        except open_xpd_uuid.GuidValidationError as e:
+            raise ValueError("Invalid format") from e
+
+    @classmethod
+    def __get_validators__(cls):
+        yield cls._validate_id
+
+    @classmethod
+    def __modify_schema__(cls, field_schema):
+        field_schema.update(
+            example="XC300001",
+        )

{openepd-4.12.0 → openepd-4.13.0}/src/openepd/model/declaration.py

@@ -17,7 +17,7 @@ import abc
 import datetime
 
 from openepd.compat.pydantic import pyd
-from openepd.model.base import BaseOpenEpdSchema, RootDocument
+from openepd.model.base import BaseOpenEpdSchema, OpenXpdUUID, RootDocument
 from openepd.model.common import Amount
 from openepd.model.geography import Geography
 from openepd.model.org import Org
@@ -34,8 +34,7 @@ THIRD_PARTY_VERIFIER_DESCRIPTION = "JSON object for Org that performed a critica
 class BaseDeclaration(RootDocument, abc.ABC):
     """Base class for declaration-related documents (EPDs, Industry-wide EPDs, Generic Estimates)."""
 
-    # TODO: Add validator for open-xpd-uuid on this field
-    id: str | None = pyd.Field(
+    id: OpenXpdUUID | None = pyd.Field(
         description="The unique ID for this document.  To ensure global uniqueness, should be registered at "
         "open-xpd-uuid.cqd.io/register or a coordinating registry.",
         example="1u7zsed8",
@@ -127,6 +126,39 @@ class BaseDeclaration(RootDocument, abc.ABC):
     """,
     )
 
+    product_image_small: pyd.AnyUrl | None = pyd.Field(
+        description="Pointer to image illustrating the product, which is no more than 200x200 pixels", default=None
+    )
+    product_image: pyd.AnyUrl | pyd.FileUrl | None = pyd.Field(
+        description="pointer to image illustrating the product no more than 10MB", default=None
+    )
+    declaration_url: str | None = pyd.Field(
+        description="Link to data object on original registrar's site",
+        example="https://epd-online.com/EmbeddedEpdList/Download/6029",
+    )
+    kg_C_per_declared_unit: AmountMass | None = pyd.Field(
+        default=None,
+        description="Mass of elemental carbon, per declared unit, contained in the product itself at the manufacturing "
+        "facility gate.  Used (among other things) to check a carbon balance or calculate incineration "
+        "emissions.  The source of carbon (e.g. biogenic) is not relevant in this field.",
+        example=Amount(qty=8.76, unit="kg"),
+    )
+    kg_C_biogenic_per_declared_unit: AmountMass | None = pyd.Field(
+        default=None,
+        description="Mass of elemental carbon from biogenic sources, per declared unit, contained in the product "
+        "itself at the manufacturing facility gate.  It may be presumed that any biogenic carbon content "
+        "has been accounted for as -44/12 kgCO2e per kg C in stages A1-A3, per EN15804 and ISO 21930.",
+        example=Amount(qty=8.76, unit="kg"),
+    )
+    product_service_life_years: float | None = pyd.Field(
+        gt=0.0009,
+        lt=101,
+        description="Reference service life of the product, in years.  Serves as a maximum for replacement interval, "
+        "which may also be constrained by usage or the service life of what the product goes into "
+        "(e.g. a building).",
+        example=50.0,
+    )
+
 
 class AverageDatasetMixin(pyd.BaseModel, title="Average Dataset"):
     """Fields common for average dataset (Industry-wide EPDs, Generic Estimates)."""
@@ -185,7 +217,7 @@ class WithEpdDeveloperMixin(pyd.BaseModel):
 class RefBase(BaseOpenEpdSchema, title="Ref Object"):
     """Base class for reference-style objects."""
 
-    id: str | None = pyd.Field(
+    id: OpenXpdUUID | None = pyd.Field(
         description="The unique ID for this object. To ensure global uniqueness, should be registered at "
         "open-xpd-uuid.cqd.io/register or a coordinating registry.",
         example="1u7zsed8",

{openepd-4.12.0 → openepd-4.13.0}/src/openepd/model/epd.py

@@ -17,7 +17,7 @@ from typing import Annotated
 
 from openepd.compat.pydantic import pyd
 from openepd.model.base import BaseDocumentFactory, OpenEpdDoctypes
-from openepd.model.common import Amount, Ingredient, WithAltIdsMixin, WithAttachmentsMixin
+from openepd.model.common import Ingredient, WithAltIdsMixin, WithAttachmentsMixin
 from openepd.model.declaration import (
     DEVELOPER_DESCRIPTION,
     PROGRAM_OPERATOR_DESCRIPTION,
@@ -30,7 +30,6 @@ from openepd.model.declaration import (
 from openepd.model.lcia import WithLciaMixin
 from openepd.model.org import Org, Plant
 from openepd.model.specs import Specs
-from openepd.model.validation.quantity import AmountMass
 from openepd.model.versioning import OpenEpdVersions, Version
 
 MANUFACTURER_DESCRIPTION = (
@@ -69,44 +68,13 @@ class EpdPreviewV0(
         max_length=2000,
         description="1-paragraph description of product. Supports plain text or github flavored markdown.",
     )
-    product_image_small: pyd.AnyUrl | None = pyd.Field(
-        description="Pointer to image illustrating the product, which is no more than 200x200 pixels", default=None
-    )
-    product_image: pyd.AnyUrl | pyd.FileUrl | None = pyd.Field(
-        description="pointer to image illustrating the product no more than 10MB", default=None
-    )
-    declaration_url: str | None = pyd.Field(
-        description="Link to data object on original registrar's site",
-        example="https://epd-online.com/EmbeddedEpdList/Download/6029",
-    )
     manufacturer: Org | None = pyd.Field(description=MANUFACTURER_DESCRIPTION)
     plants: list[Plant] = pyd.Field(
         max_items=32,
         description="List of object(s) for one or more plant(s) that this declaration applies to.",
         default_factory=list,
     )
-    kg_C_per_declared_unit: AmountMass | None = pyd.Field(
-        default=None,
-        description="Mass of elemental carbon, per declared unit, contained in the product itself at the manufacturing "
-        "facility gate.  Used (among other things) to check a carbon balance or calculate incineration "
-        "emissions.  The source of carbon (e.g. biogenic) is not relevant in this field.",
-        example=Amount(qty=8.76, unit="kg"),
-    )
-    kg_C_biogenic_per_declared_unit: AmountMass | None = pyd.Field(
-        default=None,
-        description="Mass of elemental carbon from biogenic sources, per declared unit, contained in the product "
-        "itself at the manufacturing facility gate.  It may be presumed that any biogenic carbon content "
-        "has been accounted for as -44/12 kgCO2e per kg C in stages A1-A3, per EN15804 and ISO 21930.",
-        example=Amount(qty=8.76, unit="kg"),
-    )
-    product_service_life_years: float | None = pyd.Field(
-        gt=0.0009,
-        lt=101,
-        description="Reference service life of the product, in years.  Serves as a maximum for replacement interval, "
-        "which may also be constrained by usage or the service life of what the product goes into "
-        "(e.g. a building).",
-        example=50.0,
-    )
+
     annual_production: float | None = pyd.Field(
         gt=0,
         default=None,

{openepd-4.12.0 → openepd-4.13.0}/src/openepd/model/pcr.py

@@ -18,7 +18,7 @@ from enum import StrEnum
 from typing import Annotated, Optional
 
 from openepd.compat.pydantic import pyd
-from openepd.model.base import BaseOpenEpdSchema
+from openepd.model.base import BaseOpenEpdSchema, OpenXpdUUID
 from openepd.model.common import Amount, WithAltIdsMixin, WithAttachmentsMixin
 from openepd.model.org import Org
 
@@ -36,7 +36,7 @@ class PcrStatus(StrEnum):
 class PcrRef(BaseOpenEpdSchema):
     """Reference to a PCR."""
 
-    id: str | None = pyd.Field(
+    id: OpenXpdUUID | None = pyd.Field(
         description="The unique ID for this PCR.  To ensure global uniqueness, should be registered "
         "at open-xpd-uuid.cqd.io/register or a coordinating registry.",
         example="ec3xpgq2",
@@ -56,7 +56,7 @@ class PcrRef(BaseOpenEpdSchema):
 class Pcr(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
     """Represent a PCR (Product Category Rules)."""
 
-    id: str | None = pyd.Field(
+    id: OpenXpdUUID | None = pyd.Field(
         description="The unique ID for this PCR.  To ensure global uniqueness, should be registered "
         "at open-xpd-uuid.cqd.io/register or a coordinating registry.",
         example="ec3xpgq2",