openepd 6.31.2__tar.gz → 6.32.0__tar.gz

{openepd-6.31.2 → openepd-6.32.0}/PKG-INFO

@@ -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 → openepd-6.32.0}/pyproject.toml

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

{openepd-6.31.2 → openepd-6.32.0}/src/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-6.31.2 → openepd-6.32.0}/src/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-6.31.2 → openepd-6.32.0}/src/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-6.31.2 → openepd-6.32.0}/src/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-6.31.2 → openepd-6.32.0}/src/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