openepd 6.28.0__tar.gz → 6.29.0__tar.gz

{openepd-6.28.0 → openepd-6.29.0}/PKG-INFO

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

{openepd-6.28.0 → openepd-6.29.0}/pyproject.toml

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

{openepd-6.28.0 → openepd-6.29.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.28.0"
+VERSION = "6.29.0"

{openepd-6.28.0 → openepd-6.29.0}/src/openepd/model/declaration.py

@@ -16,10 +16,12 @@
 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
+from openepd.model.common import Amount, DataUrl
 from openepd.model.geography import Geography
 from openepd.model.org import Org
 from openepd.model.pcr import Pcr
@@ -32,6 +34,14 @@ 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)."""
@@ -128,11 +138,13 @@ class BaseDeclaration(RootDocument, abc.ABC):
     """,
     )
 
-    product_image_small: pyd.AnyUrl | None = pyd.Field(
-        description="Pointer to image illustrating the product, which is no more than 200x200 pixels", default=None
+    product_image_small: pyd.AnyUrl | DataUrl | None = pyd.Field(
+        description="URL referencing an image illustrating the product.  May be a dataURL of up to 32kb.  200x200 or smaller.",
+        default=None,
     )
-    product_image: pyd.AnyUrl | pyd.FileUrl | None = pyd.Field(
-        description="pointer to image illustrating the product no more than 10MB", default=None
+    product_image: pyd.AnyUrl | pyd.FileUrl | DataUrl | None = pyd.Field(
+        description="URL referencing an image illustrating the product, of no more than 10MB.  May be a dataURL of up to 32KB.",
+        default=None,
     )
     declaration_url: str | None = pyd.Field(
         description="Link to data object on original registrar's site",
@@ -161,6 +173,13 @@ class BaseDeclaration(RootDocument, abc.ABC):
         example=50.0,
     )
 
+    @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)
+        return v
+
 
 class AverageDatasetMixin(pyd.BaseModel, title="Average Dataset"):
     """Fields common for average dataset (Industry-wide EPDs, Generic Estimates)."""