openepd 6.4.0__tar.gz → 6.4.2__tar.gz

{openepd-6.4.0 → openepd-6.4.2}/PKG-INFO

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

{openepd-6.4.0 → openepd-6.4.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openepd"
-version = "6.4.0"
+version = "6.4.2"
 license = "Apache-2.0"
 description = "Python library to work with OpenEPD format"
 authors = ["C-Change Labs <support@c-change-labs.com>"]

{openepd-6.4.0 → openepd-6.4.2}/src/openepd/__version__.py

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

{openepd-6.4.0 → openepd-6.4.2}/src/openepd/model/common.py

@@ -24,7 +24,7 @@ from openepd.model.validation.numbers import RatioFloat
 class Amount(BaseOpenEpdSchema):
     """A value-and-unit pairing for amounts that do not have an uncertainty."""
 
-    qty: float | None = pyd.Field(description="How much of this in the amount.", default=None)
+    qty: float | None = pyd.Field(description="How much of this in the amount.", ge=0, default=None)
     unit: str | None = pyd.Field(description="Which unit.  SI units are preferred.", example="kg", default=None)
 
     @pyd.root_validator
@@ -117,6 +117,18 @@ class Ingredient(BaseOpenEpdSchema):
     )
     citation: str | None = pyd.Field(default=None, description="Text citation describing the data source ")
 
+    @pyd.root_validator(skip_on_failure=True)
+    def _validate_evidence(cls, values: dict[str, Any]) -> dict[str, Any]:
+        # gwp_fraction should be backed by some type of evidence (fraction coming from product EPD etc) to be accounted
+        # for in the calculation of uncertainty
+        if values.get("gwp_fraction"):
+            if not values.get("evidence_type"):
+                raise ValueError("evidence_type is required if gwp_fraction is provided")
+            if not (values.get("citation") or values.get("link")):
+                raise ValueError("link or citation is required if gwp_fraction is provided")
+
+        return values
+
 
 class LatLng(BaseOpenEpdSchema):
     """A latitude and longitude."""

{openepd-6.4.0 → openepd-6.4.2}/src/openepd/model/epd.py

@@ -38,6 +38,7 @@ MANUFACTURER_DESCRIPTION = (
     'JSON object for declaring Org. Sometimes called the "Declaration Holder" or "Declaration Owner".'
 )
 
+PLANT_DESCRIPTION = "List of object(s) for one or more plant(s) that this declaration applies to."
 
 #
 #  Copyright 2024 by C Change Labs Inc. www.c-change-labs.com
@@ -161,7 +162,7 @@ class EpdPreviewV0(
     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.",
+        description=PLANT_DESCRIPTION,
         default_factory=list,
     )
 

{openepd-6.4.0 → openepd-6.4.2}/src/openepd/model/lcia.py

@@ -206,9 +206,17 @@ class ScopeSet(BaseOpenEpdSchema):
             if isinstance(v, Measurement):
                 all_units.add(v.unit)
 
-        # units should be the same across all measurements (textually)
-        if len(all_units) > 1:
-            raise ValueError("All scopes and measurements should be expressed in the same unit.")
+        if not cls.allowed_units:
+            # For unknown units - only units should be the same across all measurements (textually)
+            if len(all_units) > 1:
+                raise ValueError("All scopes and measurements should be expressed in the same unit.")
+        else:
+            # might be multiple variations of the same unit (kgCFC-11e, kgCFC11e)
+            if len(all_units) > 1 and ExternalValidationConfig.QUANTITY_VALIDATOR:
+                all_units_list = list(all_units)
+                first = all_units_list[0]
+                for unit in all_units_list[1:]:
+                    ExternalValidationConfig.QUANTITY_VALIDATOR.validate_same_dimensionality(first, unit)
 
         # can correctly validate unit
         if cls.allowed_units is not None and len(all_units) == 1 and ExternalValidationConfig.QUANTITY_VALIDATOR:
@@ -357,6 +365,30 @@ class ScopeSetDiseaseIncidence(ScopeSet):
     allowed_units = "AnnualPerCapita"
 
 
+class ScopeSetMass(ScopeSet):
+    """ScopeSet measuring mass in kg."""
+
+    allowed_units = "kg"
+
+
+class ScopeSetVolume(ScopeSet):
+    """ScopeSet measuring mass in kg."""
+
+    allowed_units = "m3"
+
+
+class ScopeSetMassOrVolume(ScopeSet):
+    """ScopeSet measuring mass in kg OR volume in m3, example: radioactive waste."""
+
+    allowed_units = ("kg", "m3")
+
+
+class ScopeSetEnergy(ScopeSet):
+    """ScopeSet measuring mass in kg."""
+
+    allowed_units = "MJ"
+
+
 class ImpactSet(ScopesetByNameBase):
     """A set of impacts, such as GWP, ODP, AP, EP, POCP, EP-marine, EP-terrestrial, EP-freshwater, etc."""
 
@@ -554,71 +586,71 @@ class Impacts(pyd.BaseModel):
 class ResourceUseSet(ScopesetByNameBase):
     """A set of resource use indicators, such as RPRec, RPRm, etc."""
 
-    RPRec: ScopeSet | None = pyd.Field(
+    RPRec: ScopeSetEnergy | None = pyd.Field(
         description="Renewable primary resources used as energy carrier (fuel). "
         "First use bio-based materials used as an energy source. Hydropower, solar and wind power used "
         "in the technosphere are also included in this indicator",
         default=None,
     )
-    RPRm: ScopeSet | None = pyd.Field(
+    RPRm: ScopeSetEnergy | None = pyd.Field(
         description="Renewable primary resources with energy content used as material. "
         "First use biobased materials used as materials (e.g. wood, hemp, etc.).",
         default=None,
     )
-    rpre: ScopeSet | None = pyd.Field(
+    rpre: ScopeSetEnergy | None = pyd.Field(
         description="Renewable primary energy resources as energy",
         default=None,
     )
-    nrpre: ScopeSet | None = pyd.Field(
+    nrpre: ScopeSetEnergy | None = pyd.Field(
         description="Non-renewable primary resources as energy (fuel)",
         default=None,
     )
-    nrprm: ScopeSet | None = pyd.Field(
+    nrprm: ScopeSetEnergy | None = pyd.Field(
         description="Non-renewable primary resources as material",
         default=None,
     )
-    fw: ScopeSet | None = pyd.Field(
+    fw: ScopeSetVolume | None = pyd.Field(
         description="Use of net fresh water",
         default=None,
     )
-    sm: ScopeSet | None = pyd.Field(
+    sm: ScopeSetMass | None = pyd.Field(
         description="Use of secondary materials",
         default=None,
     )
-    rsf: ScopeSet | None = pyd.Field(
+    rsf: ScopeSetEnergy | None = pyd.Field(
         description="Use of renewable secondary materials",
         default=None,
     )
-    nrsf: ScopeSet | None = pyd.Field(
+    nrsf: ScopeSetEnergy | None = pyd.Field(
         description="Use of non-renewable secondary fuels",
         default=None,
     )
-    re: ScopeSet | None = pyd.Field(
+    re: ScopeSetEnergy | None = pyd.Field(
         description="Renewable energy resources",
         default=None,
     )
-    pere: ScopeSet | None = pyd.Field(
+    pere: ScopeSetEnergy | None = pyd.Field(
         description="Use of renewable primary energy excluding renewable primary energy resources used as raw materials",
         default=None,
     )
-    perm: ScopeSet | None = pyd.Field(
+    perm: ScopeSetEnergy | None = pyd.Field(
         description="Use of renewable primary energy resources used as raw materials",
         default=None,
     )
-    pert: ScopeSet | None = pyd.Field(
+    pert: ScopeSetEnergy | None = pyd.Field(
         description="Total use of renewable primary energy resources",
         default=None,
     )
-    penre: ScopeSet | None = pyd.Field(
+    penre: ScopeSetEnergy | None = pyd.Field(
         description="Use of non-renewable primary energy excluding "
         "non-renewable primary energy resources used as raw materials",
         default=None,
     )
-    penrm: ScopeSet | None = pyd.Field(
+    penrm: ScopeSetEnergy | None = pyd.Field(
         description="Use of non-renewable primary energy resources used as raw materials",
         default=None,
     )
-    penrt: ScopeSet | None = pyd.Field(
+    penrt: ScopeSetEnergy | None = pyd.Field(
         description="Total use of non-renewable primary energy resources",
         default=None,
     )
@@ -627,51 +659,51 @@ class ResourceUseSet(ScopesetByNameBase):
 class OutputFlowSet(ScopesetByNameBase):
     """A set of output flows, such as waste, emissions, etc."""
 
-    twd: ScopeSet | None = pyd.Field(
+    twd: ScopeSetMass | None = pyd.Field(
         description="Total waste disposed",
         default=None,
     )
-    hwd: ScopeSet | None = pyd.Field(
+    hwd: ScopeSetMass | None = pyd.Field(
         description="Hazardous waste disposed",
         default=None,
     )
-    nhwd: ScopeSet | None = pyd.Field(
+    nhwd: ScopeSetMass | None = pyd.Field(
         description="Non-hazardous waste disposed",
         default=None,
     )
-    rwd: ScopeSet | None = pyd.Field(
+    rwd: ScopeSetMass | None = pyd.Field(
         description="Radioactive waste disposed",
         default=None,
     )
-    hlrw: ScopeSet | None = pyd.Field(
+    hlrw: ScopeSetMassOrVolume | None = pyd.Field(
         description="High level radioactive waste disposed",
         default=None,
     )
-    illrw: ScopeSet | None = pyd.Field(
+    illrw: ScopeSetMassOrVolume | None = pyd.Field(
         description="Intermediate level radioactive waste disposed",
         default=None,
     )
-    cru: ScopeSet | None = pyd.Field(
+    cru: ScopeSetMass | None = pyd.Field(
         description="Components for re-use",
         default=None,
     )
-    mr: ScopeSet | None = pyd.Field(
+    mr: ScopeSetMass | None = pyd.Field(
         description="Recycled materials",
         default=None,
     )
-    mfr: ScopeSet | None = pyd.Field(
+    mfr: ScopeSetMass | None = pyd.Field(
         description="Materials for recycling",
         default=None,
     )
-    mer: ScopeSet | None = pyd.Field(
+    mer: ScopeSetMass | None = pyd.Field(
         description="Materials for energy recovery",
         default=None,
     )
-    ee: ScopeSet | None = pyd.Field(
+    ee: ScopeSetEnergy | None = pyd.Field(
         description="Exported energy",
         default=None,
     )
-    eh: ScopeSet | None = pyd.Field(
+    eh: ScopeSetEnergy | None = pyd.Field(
         description="Exported heat",
         default=None,
     )

{openepd-6.4.0 → openepd-6.4.2}/src/openepd/model/org.py

@@ -66,7 +66,6 @@ class Org(WithAttachmentsMixin, WithAltIdsMixin, OrgRef):
 class Plant(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
     """Represent a manufacturing plant."""
 
-    # TODO: Add proper validator
     id: str | None = pyd.Field(
         description="Plus code (aka Open Location Code) of plant's location and "
         "owner's web domain joined with `.`(dot).",
@@ -110,6 +109,8 @@ class Plant(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
 
     @pyd.validator("id")
     def _validate_id(cls, v: str) -> str:
+        if not v:
+            return v
         try:
             pluscode, web_domain = v.split(".", maxsplit=1)
         except ValueError as e:

{openepd-6.4.0 → openepd-6.4.2}/src/openepd/model/specs/enums.py

@@ -2215,7 +2215,7 @@ class AciExposureClass(EnumGroupingAware, StrEnum):
     S1 = "aci.S1"
     S2 = "aci.S2"
     S3 = "aci.S3"
-    C0 = "aci.C1"
+    C0 = "aci.C0"
     C1 = "aci.C1"
     C2 = "aci.C2"
     W0 = "aci.W0"

{openepd-6.4.0 → openepd-6.4.2}/src/openepd/model/validation/quantity.py

@@ -33,7 +33,7 @@ class QuantityValidator(ABC):
     """
 
     @abstractmethod
-    def validate_same_dimensionality(self, unit: str | None, dimensionality_unit: str) -> None:
+    def validate_same_dimensionality(self, unit: str | None, dimensionality_unit: str | None) -> None:
         """
         Validate that a given unit ('kg') has the same dimesnionality as provided dimensionality_unit ('g').