openepd 7.9.0__tar.gz → 7.11.0__tar.gz

{openepd-7.9.0 → openepd-7.11.0}/PKG-INFO

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

{openepd-7.9.0 → openepd-7.11.0}/pyproject.toml

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

{openepd-7.9.0 → openepd-7.11.0}/src/openepd/__version__.py

@@ -13,4 +13,4 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
-VERSION = "7.9.0"
+VERSION = "7.11.0"

{openepd-7.9.0 → openepd-7.11.0}/src/openepd/api/epd/sync_api.py

@@ -13,6 +13,7 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
+from collections.abc import Collection
 from typing import Literal, overload
 
 from requests import Response
@@ -27,15 +28,17 @@ from openepd.model.epd import Epd
 class EpdApi(BaseApiMethodGroup):
     """API methods for EPDs."""
 
-    def get_by_openxpd_uuid(self, uuid: str) -> Epd:
+    def get_by_openxpd_uuid(self, uuid: str, *, fields: Collection[str] | None = None) -> Epd:
         """
         Get EPD by OpenEPD UUID.
 
         :param uuid: OpenEPD UUID
-        :return: EPD
+        :param fields: Optional collection of field names to include in the response
+        :return: EPD, Response, or tuple of EPD and Response depending on return_type
         :raise ObjectNotFound: if EPD is not found
         """
-        content = self._client.do_request("get", f"/epds/{uuid}").json()
+        params = {"fields": ",".join(set(fields))} if fields else None
+        content = self._client.do_request("get", f"/epds/{uuid}", params=params).json()
         return Epd.model_validate(content)
 
     def find_raw(self, omf: str, page_num: int = 1, page_size: int = 10) -> EpdSearchResponse:

{openepd-7.9.0 → openepd-7.11.0}/src/openepd/model/declaration.py

@@ -16,11 +16,14 @@
 import abc
 import datetime
 from enum import StrEnum
+import math
+import re
+from typing import Final
 
 import pydantic
 
 from openepd.model.base import BaseOpenEpdSchema, OpenXpdUUID, RootDocument
-from openepd.model.common import Amount
+from openepd.model.common import DATA_URL_REGEX, Amount
 from openepd.model.geography import Geography
 from openepd.model.org import Org
 from openepd.model.pcr import Pcr
@@ -33,6 +36,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)."""
@@ -138,11 +149,11 @@ class BaseDeclaration(RootDocument, abc.ABC):
     )
 
     product_image_small: pydantic.AnyUrl | None = pydantic.Field(
-        description="Pointer to image illustrating the product, which is no more than 200x200 pixels",
+        description="URL referencing an image illustrating the product.  May be a dataURL of up to 32kb.  200x200 or smaller.",
         default=None,
     )
     product_image: pydantic.AnyUrl | pydantic.FileUrl | None = pydantic.Field(
-        description="pointer to image illustrating the product no more than 10MB",
+        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 = pydantic.Field(
@@ -181,6 +192,16 @@ class BaseDeclaration(RootDocument, abc.ABC):
             return value.strip()
         return value
 
+    @pydantic.field_validator("product_image", "product_image_small")
+    def validate_product_image(cls, v: pydantic.AnyUrl | None) -> pydantic.AnyUrl | None:
+        if v and len(v) > PRODUCT_IMAGE_MAX_LENGTH:
+            msg = f"URL must not exceed {PRODUCT_IMAGE_MAX_LENGTH} characters"
+            raise ValueError(msg)
+        if v and v.scheme == "data" and not re.compile(DATA_URL_REGEX).match(str(v)):
+            msg = "Invalid data URL format"
+            raise ValueError(msg)
+        return v
+
 
 class AverageDatasetMixin(pydantic.BaseModel, title="Average Dataset"):
     """Fields common for average dataset (Industry-wide EPDs, Generic Estimates)."""

{openepd-7.9.0 → openepd-7.11.0}/src/openepd/model/epd.py

@@ -139,6 +139,7 @@ class EpdPreviewV0(
     WithEpdDeveloperMixin,
     WithVerifierMixin,
     WithAltIdsMixin,
+    EpdRef,
     BaseDeclaration,
     title="EPD (Preview)",
 ):