openepd 6.7.0__py3-none-any.whl → 6.8.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 = "6.7.0"
+VERSION = "6.8.0"

openepd/model/common.py

@@ -149,10 +149,55 @@ class Location(BaseOpenEpdSchema):
     )
 
 
+ATTACHMENT_KNOWN_KEYS: dict[str, str] = {
+    "OpenEPD": "A Product EPD in OpenEPD format",
+    "openEPD": "Equivalent to OpenEPD",
+    "ILCD_EPD": "A Product EPD in ILCD+EPD format.  An underscore is used in place of '+' for compatability purposes.",
+    "OpenIndustryEPD": "An Industry EPD in OpenEPD format",
+    "openIndustryEPD": "Equivalent to OpenIndustryEPD",
+    "LCA_Model": "An underlying LCA model from which one could replicate these EPD results, in LCA Commons 2.0 format",
+    "LCA_Report": "An underlying LCA report, in PDF or other document format",
+    "lca_software": "A url, optionally with an #anchor tag, pointing to the version of the software used, generally one provided by the software vendor. ",
+    "lca_dataset_reference": "A URL link to an lca dataset used in the analysis.  Multiple dataset references can be added by appending a number or string after _reference, e.g. lca_dataset_reference_3 or lca_dataset_reference_steel",
+    "EPD": "Environmental Product Declaration, verified by a third party, not in OpenEPD format.",
+    "IndustryEPD": "EPD for an industry, sector, or group of companies, not in OpenEPD format.",
+    "Datasheet": "A technical data sheet describing the product.",
+    "PCR": "Product Category Rules for EPD generation",
+    "Contact_Us": "A url to contact.  May be an email (mailto:) link.",
+    "URL": "A link to a relevant resource.  No particular format is specified.  Each URL should be uniquely named. ",
+    "VOC": "Volatile Organic Compound declaration",
+    "HPD": "Material Health Product Declaration",
+    "PEF": "Product Environmental Footprint (without 3rd party verification)",
+    "MSDS": "Material Safety Data Sheet",
+    "Developer": "Link to the website of the group who performed the LCA and/or prepared the EPD.",
+}
+
+
+class AttachmentDict(dict[str, pyd.AnyUrl]):
+    """Special form of dict for attachments."""
+
+    @classmethod
+    def __modify_schema__(cls, field_schema: dict[str, Any], field: pyd.fields.ModelField | None):
+        # This may be generalized later to combine, for example, enum descriptions and field descriptions to provide
+        # a better result.
+        field_description = field.field_info.description if field else ""
+        if field_description:
+            field_description = field_description.strip()
+            if not field_description.endswith("."):
+                field_description += "."
+            field_description += " "
+
+        field_schema["description"] = field_description + "Extra properties of string -> URL allowed."
+        field_schema["properties"] = {
+            k: {"type": "string", "format": "uri", "description": v} for k, v in ATTACHMENT_KNOWN_KEYS.items()
+        }
+        field_schema["additionalProperties"] = True
+
+
 class WithAttachmentsMixin(pyd.BaseModel):
     """Mixin for objects that can have attachments."""
 
-    attachments: dict[Annotated[str, pyd.Field(max_length=200)], pyd.AnyUrl] | None = pyd.Field(
+    attachments: AttachmentDict = pyd.Field(
         description="Dict of URLs relevant to this entry",
         example={
             "Contact Us": "https://www.c-change-labs.com/en/contact-us/",

openepd/model/epd.py

@@ -15,7 +15,7 @@
 #
 
 from openepd.compat.pydantic import pyd
-from openepd.model.base import BaseDocumentFactory, BaseOpenEpdSchema, OpenEpdDoctypes
+from openepd.model.base import BaseDocumentFactory, OpenEpdDoctypes, OpenEpdExtension
 from openepd.model.common import Ingredient, WithAltIdsMixin, WithAttachmentsMixin
 from openepd.model.declaration import (
     DEVELOPER_DESCRIPTION,
@@ -61,13 +61,18 @@ PLANT_DESCRIPTION = "List of object(s) for one or more plant(s) that this declar
 #
 
 
-class Ec3EpdExtension(BaseOpenEpdSchema):
+class Ec3EpdExtension(OpenEpdExtension):
     """Extension for EC3 specific fields on openEPD."""
 
     # While the extensions should be stored under the 'ext' key - extension point of the BaseOpenepdModel - the EC3
     # extension was started before the introduction of extension management, and so is located at the root of the EPD
     # object.
 
+    @classmethod
+    def get_extension_name(cls) -> str:
+        """Return the name of the extension."""
+        return "ec3"
+
     uaGWP_a1a2a3_traci21: float | None = pyd.Field(
         default=None,
         description="""The A1A2A3 uncertainty-adjusted GWP, in kgCO2e per declared unit, calculated for the TRACI 2.1

{openepd-6.7.0.dist-info → openepd-6.8.0.dist-info}/METADATA

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

{openepd-6.7.0.dist-info → openepd-6.8.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 openepd/__init__.py,sha256=Shkfh0Kun0YRhmRDw7LkUj2eQL3X-HnP55u2THOEALw,794
-openepd/__version__.py,sha256=4gnODThekFJwXNHfdYsu7FCdS-28EDHtQ3CWAlc16Dc,638
+openepd/__version__.py,sha256=9OPQvTofWeNtZsDOXlGpgiqoTls3frlEMPI9m1HFIX0,638
 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=mxWwDokEGMe87Px8C_aHvIdVKZVHrEAuVtaSA1zJchU,7953
@@ -35,9 +35,9 @@ openepd/compat/pydantic.py,sha256=DOjSixsylLqMtFAIARu50sGcT4VPXN_c473q_2JwZQ0,11
 openepd/model/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
 openepd/model/base.py,sha256=OEYNFUTL4BivBNAt_LGowTlDuUjvKMHgf5U5ZBncZwQ,9805
 openepd/model/category.py,sha256=IQXNGQFQmFZ_H9PRONloX_UOSf1sTMDq1rM1yz8JR0Y,1639
-openepd/model/common.py,sha256=4iZAdmQy5UvLKrtmO8OnXsH1HD8jl20c6cv8MUZKW-M,10356
+openepd/model/common.py,sha256=rADzzNqrjQ8oixy4KL7kyiIIvWM2S7cUDuicen1Xs6Y,13062
 openepd/model/declaration.py,sha256=oBJ_v_ESoQhybQIH5S5tmYVkgkoX3gwe3nvFyPqb4uk,13832
-openepd/model/epd.py,sha256=I8pGcvvsVzbwyQYRrqGQa7tGyRw55T_sIQn1VJ9568g,12165
+openepd/model/epd.py,sha256=Ldw_X-lo5abEXSAAxV9scjVku7NQWrsANxlIfRjkw_8,12290
 openepd/model/factory.py,sha256=XP7eeQNW5tqwX_4hfuEb3lK6BFQDb4KB0fSN0r8-lCU,2656
 openepd/model/generic_estimate.py,sha256=bbU0cR4izSqjZcfxUHNbdO4pllqqd8OaUFikrEgCFoA,3992
 openepd/model/geography.py,sha256=G3Oz3QBw5n-RiSCAv-vAGxrOZBhwIT5rASnPlo9dkcs,42095
@@ -136,7 +136,7 @@ openepd/model/validation/quantity.py,sha256=1z-G46dlryJEm4W-O0QiEJuFYICz7CPTM6gL
 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-6.7.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openepd-6.7.0.dist-info/METADATA,sha256=Iyf-1pV9bb1T9i2iY0oCm4Yaw1vvL39gaO9UEK21AKo,9038
-openepd-6.7.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-openepd-6.7.0.dist-info/RECORD,,
+openepd-6.8.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openepd-6.8.0.dist-info/METADATA,sha256=aBd0besZvKgFZrQV-rASIVpDRYZVOlRa9li7fRUk684,9038
+openepd-6.8.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+openepd-6.8.0.dist-info/RECORD,,