openepd 4.4.0__py3-none-any.whl → 4.5.1__py3-none-any.whl

openepd/__init__.py

@@ -13,3 +13,9 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
+import os
+
+from .patch_pydantic import patch_pydantic
+
+if os.environ.get("OPENEPD_DISABLE_PYDANTIC_PATCH", "false").lower() not in ("true", "1", "yes"):
+    patch_pydantic()

openepd/__version__.py

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

openepd/model/base.py

@@ -36,6 +36,7 @@ class OpenEpdDoctypes(StrEnum):
     """Enum of supported openEPD document types."""
 
     Epd = "openEPD"
+    GenericEstimate = "openGenericEstimate"
 
 
 def modify_pydantic_schema(schema_dict: dict, cls: type) -> dict:
@@ -56,28 +57,7 @@ def modify_pydantic_schema(schema_dict: dict, cls: type) -> dict:
     return schema_dict
 
 
-class PydanticClassAttributeExposeModelMetaclass(pyd.main.ModelMetaclass):
-    """
-    Extension of the pydantic's ModelMetaclass which restores class attribute lookup for fields.
-
-    In pydantic, while the model fields are defined in the model as class-level attributes, in runtime they disappear
-    due to ModelMetaclass logic. ModelMetaclass takes the defined attributes, removes them from class dict and puts
-    into a special __fields__ attribute to avoid naming conflict.
-
-    We would like to be able to access the attributes via dot notation in the runtimes, since it makes refactoring
-    easier.
-
-    This class exposes the original fields when accessed via class name. For example, one can call `Pcr.name` and get
-    `ModelField`, in addition to calling `pcr.__fields__` on an instance.
-    """
-
-    def __getattr__(cls, name: str) -> Any:
-        if name in cls.__fields__:
-            return cls.__fields__[name]
-        return getattr(super, name)
-
-
-class BaseOpenEpdSchema(pyd.BaseModel, metaclass=PydanticClassAttributeExposeModelMetaclass):
+class BaseOpenEpdSchema(pyd.BaseModel):
     """Base class for all OpenEPD models."""
 
     ext: dict[str, AnySerializable] | None = pyd.Field(alias="ext", default=None)
@@ -227,7 +207,7 @@ class BaseDocumentFactory(Generic[TRootDocument]):
     Extend it to create a factory for a specific document type e.g. for industry epd, epd, etc.
     """
 
-    DOCTYPE_CONSTRAINT: str = ""
+    DOCTYPE_CONSTRAINT: OpenEpdDoctypes
     VERSION_MAP: dict[Version, type[TRootDocument]] = {}
 
     @classmethod

openepd/model/epd.py

@@ -17,7 +17,7 @@ import datetime
 from typing import Annotated
 
 from openepd.compat.pydantic import pyd
-from openepd.model.base import BaseDocumentFactory, RootDocument
+from openepd.model.base import BaseDocumentFactory, OpenEpdDoctypes, RootDocument
 from openepd.model.common import Amount, Ingredient, WithAltIdsMixin, WithAttachmentsMixin
 from openepd.model.lcia import Impacts, OutputFlowSet, ResourceUseSet
 from openepd.model.org import Org, Plant
@@ -27,54 +27,47 @@ from openepd.model.standard import Standard
 from openepd.model.versioning import OpenEpdVersions, Version
 
 
-class BaseEpd(RootDocument):
+class BaseDeclaration(RootDocument):
     """
     Base class for EPD documents.
 
     This class should not be used directly.  Use Epd or EpdVx instead.
     """
 
-    pass
-
-
-class EpdV0(WithAttachmentsMixin, WithAltIdsMixin, BaseEpd):
-    """Represent an EPD."""
-
-    _FORMAT_VERSION = OpenEpdVersions.Version0.as_str()
-
-    # TODO: Add validator for open-xpd-uuid on this field
     id: str | None = pyd.Field(
         description="The unique ID for this EPD.  To ensure global uniqueness, should be registered at "
         "open-xpd-uuid.cqd.io/register or a coordinating registry.",
         example="1u7zsed8",
         default=None,
     )
-    product_name: str | None = pyd.Field(
-        max_length=200, description="The name of the product described by this EPD", example="Mix 12345AC", default=None
+    date_of_issue: datetime.datetime | None = pyd.Field(
+        example=datetime.datetime(day=11, month=9, year=2019, tzinfo=datetime.timezone.utc),
+        description="Date the EPD was issued. This should be the first day on which the EPD is valid.",
     )
-    product_sku: str | None = pyd.Field(
-        max_length=200, description="Unique stock keeping identifier assigned by manufacturer"
+    valid_until: datetime.datetime | None = pyd.Field(
+        example=datetime.datetime(day=11, month=9, year=2028, tzinfo=datetime.timezone.utc),
+        description="Last date the EPD is valid on, including any extensions.",
     )
-    product_description: str | None = pyd.Field(
-        max_length=2000,
-        description="1-paragraph description of product. Supports plain text or github flavored markdown.",
+
+    declared_unit: Amount | None = pyd.Field(
+        description="SI declared unit for this EPD.  If a functional unit is "
+        "utilized, the declared unit shall refer to the amount of "
+        "product associated with the A1-A3 life cycle stage."
+    )
+    kg_per_declared_unit: Amount | None = pyd.Field(
+        default=None,
+        description="Mass of the product, in kilograms, per declared unit",
+        example=Amount(qty=12.5, unit="kg"),
     )
+    compliance: list[Standard] = pyd.Field(
+        description="Standard(s) to which this declaration is compliant.", default_factory=list
+    )
+
     # TODO: add product_alt_names? E.g. ILCD has a list of synonymous names
     product_classes: dict[str, str | list[str]] = pyd.Field(
         description="List of classifications, including Masterformat and UNSPC", default_factory=dict
     )
-    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
-    )
-    version: pyd.PositiveInt | None = pyd.Field(
-        description="Version of this document. The document's issuer should increment it anytime even a single "
-        "character changes, as this value is used to determine the most recent version.",
-        example=1,
-        default=None,
-    )
+
     language: str | None = pyd.Field(
         min_length=2,
         max_length=2,
@@ -91,6 +84,80 @@ class EpdV0(WithAttachmentsMixin, WithAltIdsMixin, BaseEpd):
         "number of required fields, to allow for multiple systems to coordinate "
         "incomplete EPDs.",
     )
+    impacts: Impacts | None = pyd.Field(
+        description="List of environmental impacts, compiled per one of the standard Impact Assessment methods"
+    )
+    resource_uses: ResourceUseSet | None = pyd.Field(
+        description="Set of Resource Use Indicators, over various LCA scopes"
+    )
+    output_flows: OutputFlowSet | None = pyd.Field(
+        description="Set of Waste and Output Flow indicators which describe the waste categories "
+        "and other material output flows derived from the LCI."
+    )
+
+    pcr: Pcr | None = pyd.Field(
+        description="JSON object for product category rules. Should point to the "
+        "most-specific PCR that applies; the PCR entry should point to any "
+        "parent PCR.",
+        default=None,
+    )
+    lca_discussion: str | None = pyd.Field(
+        max_length=20000,
+        description="""A rich text description containing information for experts reviewing the EPD contents.
+    Text descriptions required by ISO 14025, ISO 21930, EN 15804,, relevant PCRs, or program instructions and which do not
+    have specific openEPD fields should be entered here.  This field may be large, and may contain multiple sections
+    separated by github flavored markdown formatting.""",
+        example="""# Packaging
+
+    Information on product-specific packaging: type, composition and possible reuse of packaging materials (paper,
+    strapping, pallets, foils, drums, etc.) shall be included in this Section. The EPD shall describe specific packaging
+    scenario assumptions, including disposition pathways for each packaging material by reuse, recycling, or landfill
+    disposal based on packaging type.*
+
+    # Product Installation
+
+    A description of the type of processing, machinery, tools, dust extraction equipment, auxiliary materials, etc.
+    to be used during installation shall be included. Information on industrial and environmental protection may be
+    included in this section. Any waste treatment included within the system boundary of installation waste should be
+    specified.
+
+    # Use Conditions
+
+    Use-stage environmental impacts of flooring products during building operations depend on product cleaning assumptions.
+    Information on cleaning frequency and cleaning products shall be provided based on the manufacturer’s recommendations.
+    In the absence of primary data, cleaning assumptions shall be documented.
+    """,
+    )
+
+
+class EpdV0(WithAttachmentsMixin, WithAltIdsMixin, BaseDeclaration):
+    """Represent an EPD."""
+
+    _FORMAT_VERSION = OpenEpdVersions.Version0.as_str()
+
+    # TODO: Add validator for open-xpd-uuid on this field
+    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_sku: str | None = pyd.Field(
+        max_length=200, description="Unique stock keeping identifier assigned by manufacturer"
+    )
+    product_description: str | None = pyd.Field(
+        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
+    )
+    version: pyd.PositiveInt | None = pyd.Field(
+        description="Version of this document. The document's issuer should increment it anytime even a single "
+        "character changes, as this value is used to determine the most recent version.",
+        example=1,
+        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",
@@ -131,30 +198,6 @@ class EpdV0(WithAttachmentsMixin, WithAltIdsMixin, BaseEpd):
     third_party_verifier_email: pyd.EmailStr | None = pyd.Field(
         description="Email address of the third party verifier", example="john.doe@example.com", default=None
     )
-    date_of_issue: datetime.datetime | None = pyd.Field(
-        example=datetime.datetime(day=11, month=9, year=2019, tzinfo=datetime.timezone.utc),
-        description="Date the EPD was issued. This should be the first day on which the EPD is valid.",
-    )
-    valid_until: datetime.datetime | None = pyd.Field(
-        example=datetime.datetime(day=11, month=9, year=2028, tzinfo=datetime.timezone.utc),
-        description="Last date the EPD is valid on, including any extensions.",
-    )
-    pcr: Pcr | None = pyd.Field(
-        description="JSON object for product category rules. Should point to the "
-        "most-specific PCR that applies; the PCR entry should point to any "
-        "parent PCR.",
-        default=None,
-    )
-    declared_unit: Amount | None = pyd.Field(
-        description="SI declared unit for this EPD.  If a functional unit is "
-        "utilized, the declared unit shall refer to the amount of "
-        "product associated with the A1-A3 life cycle stage."
-    )
-    kg_per_declared_unit: Amount | None = pyd.Field(
-        default=None,
-        description="Mass of the product, in kilograms, per declared unit",
-        example=Amount(qty=12.5, unit="kg"),
-    )
     kg_C_per_declared_unit: Amount | None = pyd.Field(
         default=None,
         description="Mass of elemental carbon, per declared unit, contained in the product itself at the manufacturing "
@@ -213,19 +256,7 @@ class EpdV0(WithAttachmentsMixin, WithAltIdsMixin, BaseEpd):
     manufacturing_image: pyd.AnyUrl | None = pyd.Field(
         description="Pointer (url) to an image illustrating the manufacturing process. No more than 10MB.", default=None
     )
-    impacts: Impacts | None = pyd.Field(
-        description="List of environmental impacts, compiled per one of the standard Impact Assessment methods"
-    )
-    resource_uses: ResourceUseSet | None = pyd.Field(
-        description="Set of Resource Use Indicators, over various LCA scopes"
-    )
-    output_flows: OutputFlowSet | None = pyd.Field(
-        description="Set of Waste and Output Flow indicators which describe the waste categories "
-        "and other material output flows derived from the LCI."
-    )
-    compliance: list[Standard] = pyd.Field(
-        description="Standard(s) to which this declaration is compliant.", default_factory=list
-    )
+
     specs: Specs = pyd.Field(
         default_factory=Specs,
         description="Data structure(s) describing performance specs of product. Unique for each material type.",
@@ -236,33 +267,6 @@ class EpdV0(WithAttachmentsMixin, WithAltIdsMixin, BaseEpd):
         "Each one should be an EPD or digitized LCI process.",
         default_factory=list,
     )
-    lca_discussion: str | None = pyd.Field(
-        max_length=20000,
-        description="""A rich text description containing information for experts reviewing the EPD contents.
-    Text descriptions required by ISO 14025, ISO 21930, EN 15804,, relevant PCRs, or program instructions and which do not
-    have specific openEPD fields should be entered here.  This field may be large, and may contain multiple sections
-    separated by github flavored markdown formatting.""",
-        example="""# Packaging
-
-    Information on product-specific packaging: type, composition and possible reuse of packaging materials (paper,
-    strapping, pallets, foils, drums, etc.) shall be included in this Section. The EPD shall describe specific packaging
-    scenario assumptions, including disposition pathways for each packaging material by reuse, recycling, or landfill
-    disposal based on packaging type.*
-
-    # Product Installation
-
-    A description of the type of processing, machinery, tools, dust extraction equipment, auxiliary materials, etc.
-    to be used during installation shall be included. Information on industrial and environmental protection may be
-    included in this section. Any waste treatment included within the system boundary of installation waste should be
-    specified.
-
-    # Use Conditions
-
-    Use-stage environmental impacts of flooring products during building operations depend on product cleaning assumptions.
-    Information on cleaning frequency and cleaning products shall be provided based on the manufacturer’s recommendations.
-    In the absence of primary data, cleaning assumptions shall be documented.
-    """,
-    )
 
     @classmethod
     def get_asset_type(cls) -> str | None:
@@ -287,8 +291,8 @@ class EpdV0(WithAttachmentsMixin, WithAltIdsMixin, BaseEpd):
 Epd = EpdV0
 
 
-class EpdFactory(BaseDocumentFactory[BaseEpd]):
+class EpdFactory(BaseDocumentFactory[BaseDeclaration]):
     """Factory for EPD objects."""
 
-    DOCTYPE_CONSTRAINT = "openEPD"
-    VERSION_MAP: dict[Version, type[BaseEpd]] = {OpenEpdVersions.Version0: EpdV0}
+    DOCTYPE_CONSTRAINT = OpenEpdDoctypes.Epd
+    VERSION_MAP: dict[Version, type[BaseDeclaration]] = {OpenEpdVersions.Version0: EpdV0}

openepd/model/factory.py

@@ -15,24 +15,26 @@
 #
 from openepd.model.base import BaseDocumentFactory, OpenEpdDoctypes, RootDocument
 from openepd.model.epd import EpdFactory
+from openepd.model.generic_estimate import GenericEstimateFactory
 
 
 class DocumentFactory:
     """A factory for creating documents regardless of the type."""
 
-    DOCTYPE_TO_FACTORY: dict[str, type[BaseDocumentFactory]] = {
+    DOCTYPE_TO_FACTORY: dict[OpenEpdDoctypes, type[BaseDocumentFactory]] = {
         OpenEpdDoctypes.Epd: EpdFactory,
+        OpenEpdDoctypes.GenericEstimate: GenericEstimateFactory,
     }
 
     @classmethod
-    def from_dict(cls, data: dict) -> RootDocument:
+    def get_factory(cls, doctype: OpenEpdDoctypes | None) -> type[BaseDocumentFactory]:
         """
-        Create a document from the dictionary.
+        Get a document factory by given doctype.
 
-        Type of the document will be recognized from the `doctype` field.
-        :raise ValueError: if the document type is not specified or not supported.
+        :param doctype: doctype
+        :return document factory
+        :raise ValueError if doctype not supported or not found.
         """
-        doctype = data.get("doctype")
         if doctype is None:
             raise ValueError("The document type is not specified.")
         factory = cls.DOCTYPE_TO_FACTORY.get(doctype)
@@ -41,4 +43,22 @@ class DocumentFactory:
                 f"The document of type `{doctype}` is not supported. Supported documents are: "
                 + ", ".join(cls.DOCTYPE_TO_FACTORY.keys())
             )
+        return factory
+
+    @classmethod
+    def from_dict(cls, data: dict) -> RootDocument:
+        """
+        Create a document from the dictionary.
+
+        Type of the document will be recognized from the `doctype` field.
+        :raise ValueError: if the document type is not specified or not supported.
+        """
+        doctype = data.get("doctype")
+        if doctype is None or not isinstance(doctype, (str, OpenEpdDoctypes)):
+            raise ValueError(
+                f"The document type is not specified or not supported. "
+                f"Please specify it in `doctype` field. Supported are: {','.join(cls.DOCTYPE_TO_FACTORY)}"
+            )
+
+        factory = cls.get_factory(OpenEpdDoctypes(doctype))
         return factory.from_dict(data)

openepd/model/generic_estimate.py

@@ -0,0 +1,85 @@
+#
+#  Copyright 2024 by C Change Labs Inc. www.c-change-labs.com
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+from enum import StrEnum
+
+from openepd.compat.pydantic import pyd
+from openepd.model.base import BaseDocumentFactory, OpenEpdDoctypes
+from openepd.model.common import WithAltIdsMixin, WithAttachmentsMixin
+from openepd.model.epd import BaseDeclaration
+from openepd.model.geography import Geography
+from openepd.model.org import Org
+from openepd.model.versioning import OpenEpdVersions, Version
+
+
+class LicenseTerms(StrEnum):
+    """Licensing terms."""
+
+    CC_BY = "CC-BY"
+    """
+    Creative Commons attribution-only license https://creativecommons.org/licenses/by/4.0/.
+    """
+    ODbL = "ODbL"
+    """
+    Open Database License per https://opendatacommons.org/licenses/odbl/
+    """
+    Government = "Government"
+    """
+    The data is offered at no charge by a government body such as the USDA or Okobaudat.
+    """
+    Other = "Other"
+    """
+    Review estimate documentation to determine license terms.
+    """
+
+
+class GenericEstimateV0(WithAttachmentsMixin, WithAltIdsMixin, BaseDeclaration):
+    """Represent a Generic Estimate."""
+
+    _FORMAT_VERSION = OpenEpdVersions.Version0.as_str()
+
+    doctype: str = pyd.Field(
+        description='Describes the type and schema of the document. Must always be "openGenericEstimate"',
+        default="openGenericEstimate",
+    )
+
+    name: str | None = pyd.Field(max_length=200, description="", default=None)
+    description: str | None = pyd.Field(
+        max_length=2000,
+        description="1-paragraph description of the Generic Estimate. Supports plain text or github flavored markdown.",
+    )
+
+    publisher: Org | None = pyd.Field(description="Organization that published the LCA results.")
+    reviewer_email: pyd.EmailStr | None = pyd.Field(
+        description="Email address of the third party verifier", example="john.doe@example.com", default=None
+    )
+    reviewer: Org | None = pyd.Field(description="Org that performed a critical review of the LCA.")
+    license_terms: LicenseTerms | None = pyd.Field(description="The license terms for use of the data.")
+    geography: list[Geography] | None = pyd.Field(
+        "Jurisdiction(s) in which the LCA result is applicable.  An empty array, or absent properties, implies global applicability."
+    )
+    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."
+    )
+
+
+GenericEstimate = GenericEstimateV0
+
+
+class GenericEstimateFactory(BaseDocumentFactory[GenericEstimate]):
+    """Factory for EPD objects."""
+
+    DOCTYPE_CONSTRAINT = OpenEpdDoctypes.GenericEstimate
+    VERSION_MAP: dict[Version, type[GenericEstimate]] = {OpenEpdVersions.Version0: GenericEstimateV0}