openepd 4.8.0__py3-none-any.whl → 4.9.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.8.0"
+VERSION = "4.9.0"

openepd/model/generic_estimate.py

@@ -16,12 +16,13 @@
 from enum import StrEnum
 
 from openepd.compat.pydantic import pyd
-from openepd.model.base import BaseDocumentFactory, OpenEpdDoctypes
+from openepd.model.base import BaseDocumentFactory, BaseOpenEpdSchema, OpenEpdDoctypes
 from openepd.model.common import WithAltIdsMixin, WithAttachmentsMixin
 from openepd.model.declaration import BaseDeclaration
 from openepd.model.geography import Geography
 from openepd.model.lcia import WithLciaMixin
 from openepd.model.org import Org
+from openepd.model.validation.common import ReferenceStr
 from openepd.model.versioning import OpenEpdVersions, Version
 
 
@@ -46,7 +47,28 @@ class LicenseTerms(StrEnum):
     """
 
 
-class GenericEstimatePreviewV0(WithAttachmentsMixin, BaseDeclaration, title="Generic Estimate (preview)"):
+class GenericEstimateRef(BaseOpenEpdSchema, title="Generic Estimate (Ref)"):
+    """Reference (short) version of Generic Estimate object."""
+
+    id: str | 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",
+        default=None,
+    )
+
+    name: str | None = pyd.Field(max_length=200, description="Name of the generic estimate", default=None)
+
+    ref: ReferenceStr | None = pyd.Field(
+        default=None,
+        example="https://openepd.buildingtransparency.org/api/generic_estimates/EC300001",
+        description="Reference to this GenericEstimate JSON object",
+    )
+
+
+class GenericEstimatePreviewV0(
+    WithAttachmentsMixin, GenericEstimateRef, BaseDeclaration, title="Generic Estimate (preview)"
+):
     """
     Generic Estimate preview, used in API list responses and where there is no need for a full object.
 
@@ -58,8 +80,6 @@ class GenericEstimatePreviewV0(WithAttachmentsMixin, BaseDeclaration, title="Gen
         default="openGenericEstimate",
     )
 
-    name: str | None = pyd.Field(max_length=200, description="Name of the generic estimate", 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.",

openepd/model/lcia.py

@@ -195,7 +195,34 @@ class ScopeSet(BaseOpenEpdSchema):
     )
 
 
-class ImpactSet(BaseOpenEpdSchema):
+class ScopesetByNameBase(BaseOpenEpdSchema):
+    """Base class for the data structures presented as typed name:scopeset mapping ."""
+
+    def get_scopeset_names(self) -> list[str]:
+        """
+        Get the names of scopesets which have been set by model (not defaults).
+
+        :return: set of names, for example ['gwp', 'odp]
+        """
+        return [self.__fields__[f].alias or f for f in self.__fields_set__]
+
+    def get_scopeset_by_name(self, name: str) -> ScopeSet | None:
+        """
+        Get scopeset by name.
+
+        :param name: The name of the scopeset.
+        :return: A scopeset if found, None otherwise
+        """
+        for f_name, f in self.__fields__.items():
+            if f.alias == name:
+                return getattr(self, f_name)
+            if f_name == name:
+                return getattr(self, f_name)
+
+        return None
+
+
+class ImpactSet(ScopesetByNameBase):
     """A set of impacts, such as GWP, ODP, AP, EP, POCP, EP-marine, EP-terrestrial, EP-freshwater, etc."""
 
     gwp: ScopeSet | None = pyd.Field(
@@ -345,7 +372,7 @@ class Impacts(pyd.BaseModel):
         return self.__root__
 
 
-class ResourceUseSet(BaseOpenEpdSchema):
+class ResourceUseSet(ScopesetByNameBase):
     """A set of resource use indicators, such as RPRec, RPRm, etc."""
 
     RPRec: ScopeSet | None = pyd.Field(
@@ -418,7 +445,7 @@ class ResourceUseSet(BaseOpenEpdSchema):
     )
 
 
-class OutputFlowSet(BaseOpenEpdSchema):
+class OutputFlowSet(ScopesetByNameBase):
     """A set of output flows, such as waste, emissions, etc."""
 
     twd: ScopeSet | None = pyd.Field(

{openepd-4.8.0.dist-info → openepd-4.9.0.dist-info}/METADATA

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

{openepd-4.8.0.dist-info → openepd-4.9.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 openepd/__init__.py,sha256=Shkfh0Kun0YRhmRDw7LkUj2eQL3X-HnP55u2THOEALw,794
-openepd/__version__.py,sha256=lqIyRxgSO7rqieyIF-IlWuLQnc58Z9-7vPOWqBlK4os,638
+openepd/__version__.py,sha256=A3iFx_kUtK0dkVs7itV9wiL0foJSKpYp8kZwKq3fk2I,638
 openepd/api/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
 openepd/api/base_sync_client.py,sha256=jviqtQgsOVdRq5x7_Yh_Tg8zIdWtVTIUqNCgebf6YDg,20925
 openepd/api/category/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
@@ -36,9 +36,9 @@ openepd/model/common.py,sha256=aa_bfotPybPoYyzHtwj5E5X1T-fCEyznMfVUWvpUhiM,5460
 openepd/model/declaration.py,sha256=5mzX24KpsezqBuGFAr-InsgB4FFNqI7HPJeDHQ93ZCI,5322
 openepd/model/epd.py,sha256=bhmPNWQQ28uhaoxE7sW8_mxyswSCEvGovQ2tH69jzUo,10324
 openepd/model/factory.py,sha256=StQUH7GNmRqskMnnRYkr_PLCl5X5sSLEPiYZOIQI9eo,2541
-openepd/model/generic_estimate.py,sha256=RSpQ4F4uVpwLg7NeymoX-V7c4vw3vbR5O4oObFON62A,4764
+openepd/model/generic_estimate.py,sha256=cAgZDiYjqNaGXKc6fR8o9380zqgQMB38F0YTQJo__Lo,5508
 openepd/model/geography.py,sha256=OngHXz-Dkg-NrVPIwNPP53xu4-HkQ_fnEfX5fYIVEfA,37417
-openepd/model/lcia.py,sha256=Cw4dwEy5Fb13XyYxpqQyGNhkuZNdjsjucAC7L1TAn7I,17560
+openepd/model/lcia.py,sha256=sDZIxyggqHIISCUocgvIEgkmqPLGNSEA3-zUd7TEgsw,18430
 openepd/model/org.py,sha256=FHcYh2WOOQrCMyzm0Ow-iP79jMTBPcneidjH6NXIklA,3760
 openepd/model/pcr.py,sha256=SwqLWMj9k_jqIzxz5mh6ttqvtLCspKSpywF5YTBOMsA,5397
 openepd/model/specs/README.md,sha256=W5LSMpZuW5x36cKS4HRfeFsClsRf8J9yHMMICghdc0s,862
@@ -91,7 +91,7 @@ openepd/model/validation/quantity.py,sha256=kzug0MZ3Ao0zeVzN-aleyxUg5hA_7D5tNOOe
 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.8.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openepd-4.8.0.dist-info/METADATA,sha256=nPib2wxgzIhOrrjVOQdEUihZ3r2ARyCo17UoY4LUllI,8534
-openepd-4.8.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-openepd-4.8.0.dist-info/RECORD,,
+openepd-4.9.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openepd-4.9.0.dist-info/METADATA,sha256=pgDKp3QMBRUOSfTtKsczMpMjOO7n_OEuFwaOz0LR6JI,8534
+openepd-4.9.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+openepd-4.9.0.dist-info/RECORD,,