openepd 6.31.2__py3-none-any.whl → 6.32.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.31.2"
+VERSION = "6.32.0"

openepd/model/common.py

@@ -15,8 +15,9 @@
 #
 from collections.abc import Callable, Generator
 from enum import StrEnum
+import math
 import re
-from typing import Annotated, Any
+from typing import Annotated, Any, Final
 
 from openepd.compat.pydantic import pyd
 from openepd.model.base import BaseOpenEpdSchema
@@ -31,6 +32,14 @@ in web pages as if they were external resources.
 The pattern matches the following format: data:[<media-type>][;base64],<data>
 """
 
+DATA_URL_IMAGE_MAX_LENGTH: Final[int] = math.ceil(32 * 1024 * 4 / 3)
+"""
+Maximum allowed length of a data URL image string to ensure the decoded image is less than 32KB.
+
+Base64 encoding overhead (approximately 33%) requires 
+limiting the encoded string length to 4/3 of the file size limit.
+"""
+
 
 class Amount(BaseOpenEpdSchema):
     """A value-and-unit pairing for amounts that do not have an uncertainty."""
@@ -336,3 +345,17 @@ class DataUrl(str):
             raise ValueError(msg)
 
         yield validator
+
+
+def validate_data_url(v: str | None, max_length: int) -> None:
+    """
+    Validate max length of data URL.
+
+    :param v: data URL string.
+    :param max_length: maximum allowed length.
+    :raises ValueError: if the data URL exceeds the maximum length.
+    :return: None
+    """
+    if v and len(v) > max_length:
+        msg = f"URL must not exceed {max_length} characters"
+        raise ValueError(msg)

openepd/model/declaration.py

@@ -16,12 +16,10 @@
 import abc
 import datetime
 from enum import StrEnum
-import math
-from typing import Final
 
 from openepd.compat.pydantic import pyd
 from openepd.model.base import BaseOpenEpdSchema, OpenXpdUUID, RootDocument
-from openepd.model.common import Amount, DataUrl
+from openepd.model.common import DATA_URL_IMAGE_MAX_LENGTH, Amount, DataUrl, validate_data_url
 from openepd.model.geography import Geography
 from openepd.model.org import Org
 from openepd.model.pcr import Pcr
@@ -34,14 +32,6 @@ DEVELOPER_DESCRIPTION = "The organization responsible for the underlying LCA (an
 PROGRAM_OPERATOR_DESCRIPTION = "JSON object for program operator Org"
 THIRD_PARTY_VERIFIER_DESCRIPTION = "JSON object for Org that performed a critical review of the EPD data"
 
-PRODUCT_IMAGE_MAX_LENGTH: Final[int] = math.ceil(32 * 1024 * 4 / 3)
-"""
-Maximum length for product_image, product_image_small fields.
-
-Image file size must be less than 32KB. Base64 encoding overhead (approximately 33%) requires 
-limiting the encoded string length to 4/3 of the file size limit.
-"""
-
 
 class BaseDeclaration(RootDocument, abc.ABC):
     """Base class for declaration-related documents (EPDs, Industry-wide EPDs, Generic Estimates)."""
@@ -175,9 +165,7 @@ class BaseDeclaration(RootDocument, abc.ABC):
 
     @pyd.validator("product_image", "product_image_small")
     def validate_product_image(cls, v: str | None) -> str | None:
-        if v and len(v) > PRODUCT_IMAGE_MAX_LENGTH:
-            msg = f"URL must not exceed {PRODUCT_IMAGE_MAX_LENGTH} characters"
-            raise ValueError(msg)
+        validate_data_url(v, DATA_URL_IMAGE_MAX_LENGTH)
         return v
 
 

openepd/model/epd.py

@@ -16,7 +16,14 @@
 
 from openepd.compat.pydantic import pyd
 from openepd.model.base import BaseDocumentFactory, OpenEpdDoctypes, OpenEpdExtension
-from openepd.model.common import Ingredient, WithAltIdsMixin, WithAttachmentsMixin
+from openepd.model.common import (
+    DATA_URL_IMAGE_MAX_LENGTH,
+    DataUrl,
+    Ingredient,
+    WithAltIdsMixin,
+    WithAttachmentsMixin,
+    validate_data_url,
+)
 from openepd.model.declaration import (
     DEVELOPER_DESCRIPTION,
     PROGRAM_OPERATOR_DESCRIPTION,
@@ -200,14 +207,14 @@ class EpdPreviewV0(
         description="Text description of how product is typically used. Can be used to describe accessories "
         "like fasteners, adhesives, etc.  Supports plain text or github flavored markdown.",
     )
-    product_usage_image: pyd.AnyUrl | None = pyd.Field(
+    product_usage_image: pyd.AnyUrl | None | DataUrl = pyd.Field(
         description="Pointer (url) to image illustrating how the product is used. No more than 10MB.", default=None
     )
     manufacturing_description: str | None = pyd.Field(
         default=None,
         description="Text description of manufacturing process.  Supports plain text or github flavored markdown.",
     )
-    manufacturing_image: pyd.AnyUrl | None = pyd.Field(
+    manufacturing_image: pyd.AnyUrl | None | DataUrl = pyd.Field(
         description="Pointer (url) to an image illustrating the manufacturing process. No more than 10MB.", default=None
     )
 
@@ -235,6 +242,11 @@ class EpdPreviewV0(
         msg = "Invalid doctype"
         raise ValueError(msg)
 
+    @pyd.validator("product_usage_image", "manufacturing_image")
+    def validate_product_image(cls, v: str | None) -> str | None:
+        validate_data_url(v, DATA_URL_IMAGE_MAX_LENGTH)
+        return v
+
 
 EpdPreview = EpdPreviewV0
 

openepd/model/org.py

@@ -13,24 +13,22 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
-import math
-from typing import Annotated, Final, Optional
+from typing import Annotated, Optional
 
 from openlocationcode import openlocationcode
 
 from openepd.compat.pydantic import pyd
 from openepd.model.base import BaseOpenEpdSchema
-from openepd.model.common import DataUrl, Location, WithAltIdsMixin, WithAttachmentsMixin
+from openepd.model.common import (
+    DATA_URL_IMAGE_MAX_LENGTH,
+    DataUrl,
+    Location,
+    WithAltIdsMixin,
+    WithAttachmentsMixin,
+    validate_data_url,
+)
 from openepd.model.validation.common import ReferenceStr
 
-ORG_LOGO_MAX_LENGTH: Final[int] = math.ceil(32 * 1024 * 4 / 3)
-"""
-Maximum length of Org.logo field.
-
-Logo file size must be less than 32KB. Base64 encoding overhead (approximately 33%) requires 
-limiting the encoded string length to 4/3 of the file size limit.
-"""
-
 
 class OrgRef(BaseOpenEpdSchema):
     """Represents Organisation with minimal data."""
@@ -105,9 +103,7 @@ class Org(WithAttachmentsMixin, WithAltIdsMixin, OrgRef):
 
     @pyd.validator("logo")
     def validate_logo(cls, v: str | None) -> str | None:
-        if v and len(v) > ORG_LOGO_MAX_LENGTH:
-            msg = f"Logo URL must not exceed {ORG_LOGO_MAX_LENGTH} characters"
-            raise ValueError(msg)
+        validate_data_url(v, DATA_URL_IMAGE_MAX_LENGTH)
         return v
 
 

{openepd-6.31.2.dist-info → openepd-6.32.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: openepd
-Version: 6.31.2
+Version: 6.32.0
 Summary: Python library to work with OpenEPD format
 License: Apache-2.0
 Author: C-Change Labs

{openepd-6.31.2.dist-info → openepd-6.32.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 openepd/__init__.py,sha256=fhxfEyEurLvSfvQci-vb3njzl_lvhcLXiZrecCOaMU8,794
-openepd/__version__.py,sha256=UFkCgstvKywEim-Fe7_uHEzuZwO946IbHObLbqlHfYQ,639
+openepd/__version__.py,sha256=B29m_wJ1prKL-Kg5P_HiWaVxsRcfdLKlPzjM3pCaZ5w,639
 openepd/api/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/api/average_dataset/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/api/average_dataset/generic_estimate_sync_api.py,sha256=_eZt_jGVL1a3p9cr-EF39Ve9Vl5sB8zwzTc_slnRL50,7975
@@ -46,15 +46,15 @@ openepd/m49/utils.py,sha256=vQl0wMXtYS2b7NeLIWilDNUopq3MATmLnhEFcMYTeZA,7256
 openepd/model/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/model/base.py,sha256=WAnVnPdsvkRumsDV6XEnYYhFjexIO1ttmzB9znkA8r8,9929
 openepd/model/category.py,sha256=reeOVRDuZPYU77EMwG0K5VjnK2H9yOGxT0PJXXqrjEk,1639
-openepd/model/common.py,sha256=YIEvA_SfUIBC2LshxqPU8jFDp0mvaDT6jNgcJXgQnQk,13877
-openepd/model/declaration.py,sha256=F7LEMeZSJndtvO0AqnvTS43MeRxI3MO1IWLyF1SlwPU,14744
-openepd/model/epd.py,sha256=SGAgEEAuvRGsIlgIUI60UqV1alhb5kouOvp8fAC0VPg,12320
+openepd/model/common.py,sha256=xJmu3PjvQwBHH8AUM247woOZeQ-r7cPI8qHBiN7Uorc,14601
+openepd/model/declaration.py,sha256=6QyFsAxbuwRiVc6vGND-tQff1IGctPjaJj3ds-8TA4Y,14343
+openepd/model/epd.py,sha256=WNxFZvcPhMPUfl-HbtDHaAP4QSm7_uG4juuZxOPJwYM,12629
 openepd/model/factory.py,sha256=UWSGpfCr3GiMTP4rzBkwqxzbXB6GKZ_5Okb1Dqa_4aA,2701
 openepd/model/generic_estimate.py,sha256=zLGTyf4Uzmp2C0m-J1ePWItSz2RGdZ0OiGPWC5nhKHk,3992
 openepd/model/geography.py,sha256=Jx7NIDdk_sIvwyh-7YxnIjAwIHW2HCQK7UtFGM2xKtw,42095
 openepd/model/industry_epd.py,sha256=QZr7OhgGkzqZ8H5p6dCIVk9zSHEYtK3y9Nk-DvkFMyk,4011
 openepd/model/lcia.py,sha256=PdaSZz02PMBJl_t2B_dmkcbzIFjA7iACrWj1fllHfw0,26230
-openepd/model/org.py,sha256=qP4VED4bcgwgyMARHF7S1LX7lkqCXMyxeIqfjgOI8gs,7927
+openepd/model/org.py,sha256=XIBDIiu-s_GZ9op9X8Eo-BAwGMUC_ecajMERj7FtoM0,7612
 openepd/model/pcr.py,sha256=7nf6ATofdrlPt81vdU6p0E8n_ftFEuCEIKxtYlFwclw,5476
 openepd/model/specs/README.md,sha256=UGhSiFJ9hOxT1mZl-5ZrhkOrPKf1W_gcu5CI9hzV7LU,2430
 openepd/model/specs/__init__.py,sha256=YbyiLnQRQIX9mEdfQRVP3Rp1q3iNwujQMBbDK2-CYdM,3836
@@ -158,7 +158,7 @@ openepd/utils/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/utils/functional.py,sha256=sm7od2_UE-cNToezBlwFQ1TCUJub1tz6VykA1X8XH-I,1274
 openepd/utils/mapping/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/utils/mapping/common.py,sha256=WphCzwQQlzX11tUk88Ubyq3QPBLvH0tBPSIuH0kmiug,7339
-openepd-6.31.2.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openepd-6.31.2.dist-info/METADATA,sha256=VYAkuvgVPMCgqN6CP6nATMUCxPxnuf7zoQs7FaQ-bnw,9827
-openepd-6.31.2.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-openepd-6.31.2.dist-info/RECORD,,
+openepd-6.32.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openepd-6.32.0.dist-info/METADATA,sha256=eagaMXfquwAt_2AXDJyK2NyJsu_8eRgsj1lzulvk_Fg,9827
+openepd-6.32.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+openepd-6.32.0.dist-info/RECORD,,