openepd 4.11.2__py3-none-any.whl → 4.12.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.11.2"
+VERSION = "4.12.0"

openepd/api/base_sync_client.py

@@ -151,6 +151,7 @@ class SyncHttpClient:
 
     HTTP_DATE_TIME_FORMAT = "%a, %d %b %Y %H:%M:%S %Z"
     DEFAULT_RETRY_INTERVAL_SEC = 10
+    DEFAULT_TIMEOUT_SEC = (15, 2 * 60)
 
     def __init__(
         self,
@@ -183,7 +184,7 @@ class SyncHttpClient:
             else throttle_retry_timeout.total_seconds()
         )
         self.user_agent = user_agent
-        self.timeout = timeout_sec
+        self.timeout = timeout_sec or self.DEFAULT_TIMEOUT_SEC
         self._session: Session | None = None
         self._auth: AuthBase | None = auth
         self._retry_count: int = retry_count

openepd/api/errors.py

@@ -55,9 +55,22 @@ class ValidationError(ApiError):
         super().__init__(http_status, error_summary, response, error_code)
         self.validation_errors: dict[str, list[str]] = validation_errors or {}
 
+    @staticmethod
+    def __flatten(nested_errors: dict[str, Any], parent_key: str = "") -> dict[str, list[str]]:
+        result: dict[str, list[str]] = {}
+        for key, value in nested_errors.items():
+            full_key = f"{parent_key}.{key}" if parent_key else key
+            if isinstance(value, dict):
+                nested_result = ValidationError.__flatten(value, full_key)
+                for nested_key, nested_errors in nested_result.items():  # type: ignore[assignment]
+                    result.setdefault(nested_key, []).extend(nested_errors)
+            else:
+                result.setdefault(full_key, []).extend(value)
+        return result
+
     def __str__(self) -> str:
         result: list[str] = ["Validation errors:"]
-        for code, errors in self.validation_errors.items():
+        for code, errors in self.__flatten(self.validation_errors).items():  # type: ignore[arg-type]
             result.append(f"{code}:")
             for e in errors:
                 result.append(f"  {e}")

openepd/model/base.py

@@ -183,7 +183,7 @@ class RootDocument(abc.ABC, BaseOpenEpdSchema):
 
     doctype: str = pyd.Field(
         description='Describes the type and schema of the document. Must always always read "openEPD".',
-        default="OpenEPD",
+        default="openEPD",
     )
     openepd_version: str = pyd.Field(
         description="Version of the document format, related to /doctype",

openepd/model/common.py

@@ -29,7 +29,7 @@ class Amount(BaseOpenEpdSchema):
     @pyd.root_validator
     def check_qty_or_unit(cls, values: dict[str, Any]):
         """Ensure that qty or unit is provided."""
-        if values["qty"] is None and values["unit"] is None:
+        if values.get("qty") is None and values.get("unit") is None:
             raise ValueError("Either qty or unit must be provided.")
         return values
 

openepd/model/declaration.py

@@ -24,6 +24,7 @@ from openepd.model.org import Org
 from openepd.model.pcr import Pcr
 from openepd.model.standard import Standard
 from openepd.model.validation.common import ReferenceStr
+from openepd.model.validation.quantity import AmountMass
 
 DEVELOPER_DESCRIPTION = "The organization responsible for the underlying LCA (and subsequent summarization as EPD)."
 PROGRAM_OPERATOR_DESCRIPTION = "JSON object for program operator Org"
@@ -61,7 +62,7 @@ class BaseDeclaration(RootDocument, abc.ABC):
         "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(
+    kg_per_declared_unit: AmountMass | None = pyd.Field(
         default=None,
         description="Mass of the product, in kilograms, per declared unit",
         example=Amount(qty=12.5, unit="kg").to_serializable(exclude_unset=True),

openepd/model/epd.py

@@ -30,6 +30,7 @@ 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 = (
@@ -53,6 +54,11 @@ class EpdPreviewV0(
 
     """
 
+    doctype: str = pyd.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
     )
@@ -79,14 +85,14 @@ class EpdPreviewV0(
         description="List of object(s) for one or more plant(s) that this declaration applies to.",
         default_factory=list,
     )
-    kg_C_per_declared_unit: Amount | None = pyd.Field(
+    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: Amount | None = pyd.Field(
+    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 "
@@ -149,6 +155,17 @@ class EpdPreviewV0(
         default_factory=list,
     )
 
+    @pyd.validator("doctype")
+    def validate_doctype(cls, v: str | None) -> str:
+        """
+        Handle possible mixed case options for doctype.
+
+        Required for backward compatibility as some code might have already used 'doctype: OpenEPD' instead of 'openEPD'
+        """
+        if not v or v.lower() == "openepd":
+            return "openEPD"
+        raise ValueError("Invalid doctype")
+
 
 EpdPreview = EpdPreviewV0
 

openepd/model/generic_estimate.py

@@ -14,6 +14,7 @@
 #  limitations under the License.
 #
 from enum import StrEnum
+from typing import Literal
 
 from openepd.compat.pydantic import pyd
 from openepd.model.base import BaseDocumentFactory, OpenEpdDoctypes
@@ -60,7 +61,7 @@ class GenericEstimatePreviewV0(
 
     _FORMAT_VERSION = OpenEpdVersions.Version0.as_str()
 
-    doctype: str = pyd.Field(
+    doctype: Literal["openGenericEstimate"] = pyd.Field(
         description='Describes the type and schema of the document. Must always be "openGenericEstimate"',
         default="openGenericEstimate",
     )

openepd/model/industry_epd.py

@@ -13,6 +13,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
+from typing import Literal
+
 from openepd.compat.pydantic import pyd
 from openepd.model.base import BaseDocumentFactory, OpenEpdDoctypes
 from openepd.model.common import WithAltIdsMixin, WithAttachmentsMixin
@@ -51,7 +53,7 @@ class IndustryEpdPreviewV0(
 
     _FORMAT_VERSION = OpenEpdVersions.Version0.as_str()
 
-    doctype: str = pyd.Field(
+    doctype: Literal["openIndustryEpd"] = pyd.Field(
         description='Describes the type and schema of the document. Must always be "openIndustryEpd"',
         default="openIndustryEpd",
     )

openepd/model/lcia.py

@@ -204,7 +204,7 @@ class ScopesetByNameBase(BaseOpenEpdSchema):
 
         :return: set of names, for example ['gwp', 'odp]
         """
-        return [self.__fields__[f].alias or f for f in self.__fields_set__]
+        return [self.__fields__[f].alias or f for f in self.__fields_set__ if f not in ("ext",)]
 
     def get_scopeset_by_name(self, name: str) -> ScopeSet | None:
         """

openepd/model/validation/quantity.py

@@ -14,9 +14,10 @@
 #  limitations under the License.
 #
 from abc import ABC, abstractmethod
-from typing import TYPE_CHECKING, Callable, ClassVar
+from typing import TYPE_CHECKING, Any, Callable, ClassVar
 
-from openepd.model.common import OpenEPDUnit
+from openepd.compat.pydantic import pyd
+from openepd.model.common import Amount, OpenEPDUnit
 
 if TYPE_CHECKING:
     from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
@@ -127,6 +128,32 @@ def validate_quantity_for_new_validator(max_value: str) -> Callable:
 # todo these types should be replaced by Annotated[str, AfterValidator...] as we move completely to pydantic 2
 
 
+class AmountWithDimensionality(Amount, ABC):
+    """Class for dimensionality-validated amounts."""
+
+    dimensionality_unit: ClassVar[str | None] = None
+
+    # Unit for dimensionality to validate against, for example "kg"
+
+    @pyd.root_validator
+    def check_dimensionality_matches(cls, values: dict[str, Any]) -> dict[str, Any]:
+        """Check that this amount conforms to the same dimensionality as dimensionality_unit."""
+        if not cls.dimensionality_unit:
+            return values
+
+        from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
+
+        str_repr = f"{values['qty']} {values['unit']}"
+        validate_unit_factory(cls.dimensionality_unit)(BaseOpenEpdHierarchicalSpec, str_repr)
+        return values
+
+
+class AmountMass(AmountWithDimensionality):
+    """Amount of mass, measured in kg, t, etc."""
+
+    dimensionality_unit = OpenEPDUnit.kg
+
+
 class QuantityStr(str):
     """
     Quantity string type.

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

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

{openepd-4.11.2.dist-info → openepd-4.12.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
 openepd/__init__.py,sha256=Shkfh0Kun0YRhmRDw7LkUj2eQL3X-HnP55u2THOEALw,794
-openepd/__version__.py,sha256=U8LswEaiWPCNIDjB1vi1pVrd5F-2GUY1cSsEF-9K92I,639
+openepd/__version__.py,sha256=21tmVPyiMCbot4ApEc5ODeqH2q7qPuAfknYig3smndc,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
 openepd/api/average_dataset/industry_epd_sync_api.py,sha256=xoicuZdclf4BTBa2ndG1K2Aog-iZd7_jOqdDPZSCLq4,6286
-openepd/api/base_sync_client.py,sha256=jviqtQgsOVdRq5x7_Yh_Tg8zIdWtVTIUqNCgebf6YDg,20925
+openepd/api/base_sync_client.py,sha256=IX-q6JdWLMqYHC-hKLXUFRPs-DZZ9Co0NRZ5pSAipAs,20992
 openepd/api/category/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
 openepd/api/category/dto.py,sha256=tDojagSwT7CTtcYq31Qe_c0P3xKKUWXKdzT5iN6odtk,850
 openepd/api/category/sync_api.py,sha256=VHHOVbblZGyc4AtbsgQza00trSLuaCO6KfQw6r8vzgg,1371
@@ -18,7 +18,7 @@ openepd/api/dto/params.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
 openepd/api/epd/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
 openepd/api/epd/dto.py,sha256=NZ76vfUkCEkwDibQd2QCEQP5DZms_NFc9tjoP-mcw3o,4874
 openepd/api/epd/sync_api.py,sha256=5wuPiM_zVciVtTvsGaaRdf7T6q2CUp7QMZCW0DAjQng,7072
-openepd/api/errors.py,sha256=Pcg2JqjLoUXUFJTVdIFbd8rgjGoAT5HpnivTpFRACVU,2159
+openepd/api/errors.py,sha256=Iipd0QW2tbhUu_UjUbmiFWgmrPVgOFHc3uxZN-SX-g4,2868
 openepd/api/pcr/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
 openepd/api/pcr/sync_api.py,sha256=Riu77h8uLJngKpITOiXYmO7mzjAHpYskUJ6ynyfNG78,1557
 openepd/api/sync_client.py,sha256=IurnhZrkBQoQIbbfon6TPuhjGpAV_CSTJNeXjIiN0QI,3105
@@ -33,16 +33,16 @@ 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=o6miTbb4d2BRQ6epN5Jn8mIMkAeoAucd_3op7aEMELc,9044
+openepd/model/base.py,sha256=h3lUv5XuROAuCyJ68FZ0hkoyiqDRxXpjfxp2c0CGvOU,9044
 openepd/model/category.py,sha256=IQXNGQFQmFZ_H9PRONloX_UOSf1sTMDq1rM1yz8JR0Y,1639
-openepd/model/common.py,sha256=aa_bfotPybPoYyzHtwj5E5X1T-fCEyznMfVUWvpUhiM,5460
-openepd/model/declaration.py,sha256=RFkjoEKD9QRzOMzd-svXVezzHZsrbPziZhME8SjmV44,8938
-openepd/model/epd.py,sha256=FfU36K5B1iVYksPPvKsg8rZgaO1EKxQar9QcAjAGyiE,8731
+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/factory.py,sha256=XP7eeQNW5tqwX_4hfuEb3lK6BFQDb4KB0fSN0r8-lCU,2656
-openepd/model/generic_estimate.py,sha256=kBRtW6yAXgV3YkflXOI1jy8Tav5k5y8M3MPnuKPCcA4,3938
+openepd/model/generic_estimate.py,sha256=bbU0cR4izSqjZcfxUHNbdO4pllqqd8OaUFikrEgCFoA,3992
 openepd/model/geography.py,sha256=eCt15zXKDtiteNwXQ675cFwBXQqSpiGpIqwDo4nkOek,42091
-openepd/model/industry_epd.py,sha256=39D8WlLrEUwHLwhUcOQgjcLFQq5xz3fpwkpIfTaXRek,3234
-openepd/model/lcia.py,sha256=bnDVsEo429Go_EneVOkXYIxDu2soxrgxyfzU4OhDR3Q,18827
+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/specs/README.md,sha256=W5LSMpZuW5x36cKS4HRfeFsClsRf8J9yHMMICghdc0s,862
@@ -93,11 +93,11 @@ openepd/model/standard.py,sha256=QhGpWN3U27fDcS0Yy1Dk8ElJfD0etet6i_PzoTD6B48,131
 openepd/model/validation/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
 openepd/model/validation/common.py,sha256=FLYqK8gYFagx08LCkS0jy3qo4-Zq9VAv5i8ZwF2svkc,2435
 openepd/model/validation/numbers.py,sha256=tgirqrDGgrSo6APGlW1ozNuVV8mJz_4HCAXS2OUENq0,888
-openepd/model/validation/quantity.py,sha256=kzug0MZ3Ao0zeVzN-aleyxUg5hA_7D5tNOOerverfRQ,7415
+openepd/model/validation/quantity.py,sha256=h4AXXMijFtJRFUb5bi_iRzK2v7v1CtggLi7CyK5bA4s,8349
 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.11.2.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openepd-4.11.2.dist-info/METADATA,sha256=D_aVy2u1IP9MMlExPDasxBPahE67B9amDelWGmCanyw,8705
-openepd-4.11.2.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-openepd-4.11.2.dist-info/RECORD,,
+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,,