openepd 4.12.0__py3-none-any.whl → 4.13.0__py3-none-any.whl

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/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/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/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/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",

{openepd-4.12.0.dist-info → openepd-4.13.0.dist-info}/METADATA

@@ -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.dist-info → openepd-4.13.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 openepd/__init__.py,sha256=Shkfh0Kun0YRhmRDw7LkUj2eQL3X-HnP55u2THOEALw,794
-openepd/__version__.py,sha256=21tmVPyiMCbot4ApEc5ODeqH2q7qPuAfknYig3smndc,639
+openepd/__version__.py,sha256=ct2ojZmiO087rEAYSPIKIFv4c6Tf57TQ7E0AKUt3Iyw,639
 openepd/api/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
 openepd/api/average_dataset/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
 openepd/api/average_dataset/generic_estimate_sync_api.py,sha256=DM7i8gugUIEAutEsakEUxFjwgtKmcytkjvNAvfhVYUs,7690
@@ -33,18 +33,18 @@ openepd/compat/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,62
 openepd/compat/compat_functional_validators.py,sha256=yz6DfWeg7knBHEN_enpCGGTLRknEsecXfpzD1FDlywY,834
 openepd/compat/pydantic.py,sha256=DOjSixsylLqMtFAIARu50sGcT4VPXN_c473q_2JwZQ0,1146
 openepd/model/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
-openepd/model/base.py,sha256=h3lUv5XuROAuCyJ68FZ0hkoyiqDRxXpjfxp2c0CGvOU,9044
+openepd/model/base.py,sha256=OEYNFUTL4BivBNAt_LGowTlDuUjvKMHgf5U5ZBncZwQ,9805
 openepd/model/category.py,sha256=IQXNGQFQmFZ_H9PRONloX_UOSf1sTMDq1rM1yz8JR0Y,1639
 openepd/model/common.py,sha256=hXnz2QiQDx3Z7F4BMHlHQ2iddq3OonKrveltl-nOiEI,5468
-openepd/model/declaration.py,sha256=W4bTm423_vMf8i0nsrEy9iw0fwNGOD-9yvpuRlXt-4o,8999
-openepd/model/epd.py,sha256=fZJxgbpPUc8IINfrVpHG9fUWSf_XWJfMPK9lMhN0qME,9368
+openepd/model/declaration.py,sha256=9KnmYr3ZLpkbBFVkesaEdDtGpG-SrVFuIOO2ekRyTgk,10796
+openepd/model/epd.py,sha256=GU7OW6hp9GeLB9PUGqacDYMAJVWmAAHzGp3dZs2aGqo,7479
 openepd/model/factory.py,sha256=XP7eeQNW5tqwX_4hfuEb3lK6BFQDb4KB0fSN0r8-lCU,2656
 openepd/model/generic_estimate.py,sha256=bbU0cR4izSqjZcfxUHNbdO4pllqqd8OaUFikrEgCFoA,3992
 openepd/model/geography.py,sha256=eCt15zXKDtiteNwXQ675cFwBXQqSpiGpIqwDo4nkOek,42091
 openepd/model/industry_epd.py,sha256=rgXhCUDAgzZ9eGio7ExqE3ymP3zTXnrrwcIDvg5YP1A,3285
 openepd/model/lcia.py,sha256=pVh4LbZgzDuLuM3epdCNLlAp5B0BnUrwggaaDiuPccM,18848
 openepd/model/org.py,sha256=FHcYh2WOOQrCMyzm0Ow-iP79jMTBPcneidjH6NXIklA,3760
-openepd/model/pcr.py,sha256=SwqLWMj9k_jqIzxz5mh6ttqvtLCspKSpywF5YTBOMsA,5397
+openepd/model/pcr.py,sha256=1abCO00f_zaZrGiBN4fzauQ-5zPhNc31RXFUJzLVIJ0,5426
 openepd/model/specs/README.md,sha256=W5LSMpZuW5x36cKS4HRfeFsClsRf8J9yHMMICghdc0s,862
 openepd/model/specs/__init__.py,sha256=CfuCZKFE6xysags8XY9VlW-o_zHEyCu9fGekoj-RJOg,4959
 openepd/model/specs/asphalt.py,sha256=kyv-WvqujYD5xqi-lS2nSculXLQAuuBbJU_YRCb-5ug,3332
@@ -97,7 +97,7 @@ openepd/model/validation/quantity.py,sha256=h4AXXMijFtJRFUb5bi_iRzK2v7v1CtggLi7C
 openepd/model/versioning.py,sha256=R_zm6rCrgF3vlJQYbpyWhirdS_Oek16cv_mvZmpuE8I,4473
 openepd/patch_pydantic.py,sha256=xrkzblatmU9HBzukWkp1cPq9ZSuohoz1p0pQqVKSlKs,4122
 openepd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openepd-4.12.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openepd-4.12.0.dist-info/METADATA,sha256=1mNyCyep7uh_aBL0WoQIM303D5gIkA30Upv_E3pHSx4,8705
-openepd-4.12.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-openepd-4.12.0.dist-info/RECORD,,
+openepd-4.13.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openepd-4.13.0.dist-info/METADATA,sha256=eO3P8R_93hVQpLWCZOuDVScaXDdq8wsYkahzx5N7ifo,8705
+openepd-4.13.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+openepd-4.13.0.dist-info/RECORD,,