openepd 6.20.0__py3-none-any.whl → 6.21.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.20.0"
+VERSION = "6.21.0"

openepd/bundle/base.py

@@ -64,6 +64,46 @@ class BundleMixin:
         else:
             return asset_ref
 
+    @classmethod
+    def _asset_refs_to_str(cls, asset_refs: AssetRef | list[AssetRef] | None) -> list[str] | str | None:
+        """Convert single or multiple asset references to strings."""
+        if asset_refs is None:
+            return None
+        if isinstance(asset_refs, list):
+            return [cls._asset_ref_to_str(asset_ref) for asset_ref in asset_refs]
+        else:
+            return cls._asset_ref_to_str(asset_refs)
+
+    @classmethod
+    def _serialize_rel_asset_for_csv(cls, rel_asset: list[str] | str | None) -> str | None:
+        """
+        Serialize rel_asset for CSV storage.
+
+        Multiple assets are joined with semicolons.
+        """
+        if rel_asset is None:
+            return None
+        if isinstance(rel_asset, list):
+            # For empty list, return None. For non-empty list, join with semicolons
+            return ";".join(rel_asset) if rel_asset else None
+        else:
+            # Single asset - return as string
+            return str(rel_asset)
+
+    @classmethod
+    def _deserialize_rel_asset_from_csv(cls, rel_asset_str: str | None) -> list[str] | str | None:
+        """
+        Deserialize rel_asset from CSV storage.
+
+        Semicolon-separated values become lists.
+        """
+        if rel_asset_str is None or rel_asset_str == "":
+            return None
+        if ";" in rel_asset_str:
+            return rel_asset_str.split(";")
+        else:
+            return rel_asset_str
+
 
 class BaseBundleReader(BundleMixin, metaclass=abc.ABCMeta):
     """Base class for bundle readers."""
@@ -180,7 +220,7 @@ class BaseBundleWriter(BundleMixin, metaclass=abc.ABCMeta):
         self,
         data: IO[bytes],
         content_type: str | None,
-        rel_asset: AssetRef | None = None,
+        rel_asset: AssetRef | list[AssetRef] | None = None,
         rel_type: str | None = None,
         file_name: str | None = None,
         name: str | None = None,
@@ -196,7 +236,7 @@ class BaseBundleWriter(BundleMixin, metaclass=abc.ABCMeta):
     def write_object_asset(
         self,
         obj: TOpenEpdObject,
-        rel_asset: AssetRef | None = None,
+        rel_asset: AssetRef | list[AssetRef] | None = None,
         rel_type: str | None = None,
         file_name: str | None = None,
         name: str | None = None,

openepd/bundle/model.py

@@ -79,6 +79,7 @@ class AssetInfo(BaseOpenEpdSchema):
     """The language of the asset."""
     rel_type: str | None
     rel_asset: str | None
+    """The related asset reference (serialized as semicolon-separated for multiple assets)."""
     comment: str | None = pyd.Field(default=None)
     content_type: str | None = pyd.Field(default=None)
     size: int | None = pyd.Field(default=None)

openepd/bundle/reader.py

@@ -61,8 +61,12 @@ class DefaultBundleReader(BaseBundleReader):
                 return False
             if name is not None and a.name != name:
                 return False
-            if parent_ref is not None and a.rel_asset != parent_ref:
-                return False
+            if parent_ref is not None:
+                parent_ref_str = self._asset_ref_to_str(parent_ref)
+                # Get the actual list of related assets
+                rel_asset_list = self._get_rel_asset_list(a)
+                if parent_ref_str not in rel_asset_list:
+                    return False
             if ref_type is not None and a.rel_type != ref_type:
                 return False
             if is_translated is not None and a.lang is not None and "translated" in a.lang:
@@ -78,6 +82,20 @@ class DefaultBundleReader(BaseBundleReader):
                 input_dict[x] = None
         return input_dict
 
+    def _get_rel_asset_list(self, asset_info: AssetInfo) -> list[str]:
+        """Get the list of related asset references from an AssetInfo object."""
+        if asset_info.rel_asset is None:
+            return []
+
+        # Deserialize from CSV format (semicolon-separated values)
+        deserialized = self._deserialize_rel_asset_from_csv(asset_info.rel_asset)
+        if isinstance(deserialized, list):
+            return deserialized
+        elif isinstance(deserialized, str):
+            return [deserialized]
+        else:
+            return []
+
     def assets_iter(self) -> Iterator[AssetInfo]:
         """Iterate over all assets in the bundle."""
         with self._bundle_archive.open("toc", "r") as toc_stream:
@@ -125,7 +143,8 @@ class DefaultBundleReader(BaseBundleReader):
             rel_type = [rel_type]
         asset_ref = self._asset_ref_to_str(asset)
         for x in self.assets_iter():
-            if x.rel_asset == asset_ref:
+            rel_asset_list = self._get_rel_asset_list(x)
+            if asset_ref in rel_asset_list:
                 if rel_type is None or x.rel_type in rel_type:
                     yield x
 

openepd/bundle/writer.py

@@ -50,7 +50,7 @@ class DefaultBundleWriter(BaseBundleWriter):
         self,
         data: IO[bytes],
         content_type: str | None = None,
-        rel_asset: AssetRef | None = None,
+        rel_asset: AssetRef | list[AssetRef] | None = None,
         rel_type: str | None = None,
         file_name: str | None = None,
         name: str | None = None,
@@ -60,7 +60,10 @@ class DefaultBundleWriter(BaseBundleWriter):
         custom_data: str | None = None,
     ) -> AssetInfo:
         """Write a blob asset to the bundle."""
-        rel_ref_str = self._asset_ref_to_str(rel_asset) if rel_asset is not None else None
+        # Convert multiple rel_asset to proper format and serialize for storage
+        rel_ref_converted = self._asset_refs_to_str(rel_asset)
+        rel_ref_serialized = self._serialize_rel_asset_for_csv(rel_ref_converted)
+
         ref_str = self.__generate_entry_name(
             AssetType.Blob, self.__get_ext_for_content_type(content_type, "bin"), file_name
         )
@@ -70,7 +73,7 @@ class DefaultBundleWriter(BaseBundleWriter):
             type=AssetType.Blob,
             lang=lang,
             rel_type=rel_type,
-            rel_asset=rel_ref_str,
+            rel_asset=rel_ref_serialized,
             content_type=content_type,
             comment=comment,
             custom_type=custom_type,
@@ -83,7 +86,7 @@ class DefaultBundleWriter(BaseBundleWriter):
     def write_object_asset(
         self,
         obj: TOpenEpdObject,
-        rel_asset: AssetRef | None = None,
+        rel_asset: list[AssetRef] | AssetRef | None = None,
         rel_type: str | None = None,
         file_name: str | None = None,
         name: str | None = None,
@@ -98,7 +101,11 @@ class DefaultBundleWriter(BaseBundleWriter):
             msg = f"Object {obj} does not have a valid asset type and can't be written to a bundle."
             raise ValueError(msg)
         asset_type = AssetType(asset_type_str)
-        rel_ref_str = self._asset_ref_to_str(rel_asset) if rel_asset is not None else None
+
+        # Convert multiple rel_asset to proper format and serialize for storage
+        rel_ref_converted = self._asset_refs_to_str(rel_asset)
+        rel_ref_serialized = self._serialize_rel_asset_for_csv(rel_ref_converted)
+
         ref_str = self.__generate_entry_name(
             asset_type, self.__get_ext_for_content_type("application/json", "json"), file_name
         )
@@ -107,7 +114,7 @@ class DefaultBundleWriter(BaseBundleWriter):
             name=name,
             type=asset_type,
             lang=lang,
-            rel_asset=rel_ref_str,
+            rel_asset=rel_ref_serialized,
             rel_type=rel_type,
             content_type="application/json",
             comment=comment,

{openepd-6.20.0.dist-info → openepd-6.21.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: openepd
-Version: 6.20.0
+Version: 6.21.0
 Summary: Python library to work with OpenEPD format
 License: Apache-2.0
 Author: C-Change Labs
@@ -8,7 +8,7 @@ Author-email: support@c-change-labs.com
 Maintainer: C-Change Labs
 Maintainer-email: open-source@c-change-labs.com
 Requires-Python: >=3.11,<4.0
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
@@ -20,7 +20,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Provides-Extra: api-client
 Requires-Dist: email-validator (>=1.3.1)
 Requires-Dist: idna (>=3.7)
-Requires-Dist: open-xpd-uuid (>=0.2.1,<0.3.0)
+Requires-Dist: open-xpd-uuid (>=0.2.1,<2)
 Requires-Dist: openlocationcode (>=1.0.1)
 Requires-Dist: pydantic (>=1.10,<3.0)
 Requires-Dist: requests (>=2.0) ; extra == "api-client"
@@ -44,6 +44,24 @@ Description-Content-Type: text/markdown
 
 This library is a Python library to work with OpenEPD format.
 
+> ⚠️ **Version Warning**
+>
+> This application is currently developed in **two major versions** in parallel:
+>
+> - **v6.x (>=6.0.0)** — Stable and production-ready. Maintains support for Pydantic v1 and v2 through a compatibility layer.
+> - **v7.x (>=7.0.0)** — Public beta. Fully functional, with native support for Pydantic v2. Still experimental and may introduce breaking changes in **internal and integration interfaces**.
+>
+> ⚠️ No breaking changes are expected in the **public standard or data model**, only in internal APIs and integration points.
+> 
+> Both versions currently offer the same set of features.  
+> We recommend using **v6** for most production use cases as the more mature and stable option.  
+> **v7** is suitable for production environments that can tolerate some level of interface instability and want to adopt the latest internals.
+>
+> 💡 Only the **latest version of v7** is guaranteed to contain all the features and updates from v6. Earlier v7 releases may lack some recent improvements.
+>
+> Once **v7 is promoted to stable**, all earlier **pre-stable (beta) v7 releases** will be **marked as yanked** to prevent accidental usage in production.
+>
+
 ## About OpenEPD
 
 [openEPD](https://www.buildingtransparency.org/programs/openepd/) is an open data format for passing digital
@@ -63,13 +81,6 @@ documenting supply-chain specific data.
 
 ## Usage
 
-**❗ ATTENTION**: Pick the right version. The cornerstone of this library models package representing openEPD models.
-Models are defined with Pydantic library which is a dependency for openepd package. If you use Pydantic in your project
-carefully pick the version:
-
-* Use version **below** `2.0.0` if your project uses Pydantic version below `2.0.0`
-* Use version `2.x.x` or higher if your project uses Pydantic version `2.0.0` or above
-
 ### Models
 
 The library provides the Pydantic models for all the OpenEPD entities. The models are available in the `openepd.models`

{openepd-6.20.0.dist-info → openepd-6.21.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 openepd/__init__.py,sha256=fhxfEyEurLvSfvQci-vb3njzl_lvhcLXiZrecCOaMU8,794
-openepd/__version__.py,sha256=qqFv4TdG_QezASXat2Iyq25c6fS3PUY0MuIdqETulzQ,639
+openepd/__version__.py,sha256=k7n_fLDUizaOEiiaI-LYyq8UKQvC3djSX4Z3eV0EjcI,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
@@ -31,10 +31,10 @@ openepd/api/sync_client.py,sha256=DiDSQU0kBd9gU17KrPUvo07pyLv15rGozuWXbkM1JzA,40
 openepd/api/test/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/api/utils.py,sha256=xOU8ihC0eghsoaCFhC85PU4WYRwNxVEpfK3gzq4e9ik,2092
 openepd/bundle/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
-openepd/bundle/base.py,sha256=ovURf721k9XWe0C8-tmik_bEOrHdOtF1jbN03T5G7M4,6918
-openepd/bundle/model.py,sha256=_fQWW1KsxKquFFB6JtU3dyc82re1vqmwMpxe6zUEfSE,2605
-openepd/bundle/reader.py,sha256=YvTXglxp8HLxkaOUdbvOuyA9qeN3vt_PjlAroOSzNO0,6822
-openepd/bundle/writer.py,sha256=qfQWlGnbQxzim8mMbDKRyBpdEXDe60nyNbgjAbG0eq8,8245
+openepd/bundle/base.py,sha256=2tv7KbxG9zC_nuMOGudorxZcTl5rU6ABJmEbO2WTPas,8400
+openepd/bundle/model.py,sha256=uQto8zfI4wdCOpNAhhMPrsGIeyoKNMMJSmXJk6LlwC8,2700
+openepd/bundle/reader.py,sha256=Qu6KM68tbaoSPRYSqkEKLgWjdl_c7pVAWIDHJK32aaQ,7653
+openepd/bundle/writer.py,sha256=kX1vJ3z96W1TxYwy152hHbmHul_7jcxUXV8psOhtr18,8564
 openepd/compat/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/compat/compat_functional_validators.py,sha256=aWg3a80fqT8zjN0S260N-Ad2WFKAaB8ByN7ArBW3NMA,834
 openepd/compat/pydantic.py,sha256=HZJmAiYO7s-LLcFHuj3iXS4MGOITExZYn2rPmteoqNI,1146
@@ -150,7 +150,7 @@ openepd/model/validation/quantity.py,sha256=mP4gIkeOGZuHRhprsf_BX11Cic75NssYxOTk
 openepd/model/versioning.py,sha256=wBZdOVL3ND9FMIRU9PS3vx9M_7MBiO70xYPQvPez6po,4522
 openepd/patch_pydantic.py,sha256=bO7U5HqthFol0vfycb0a42UAGL3KOQ8-9MW4yCWOFP0,4150
 openepd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openepd-6.20.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openepd-6.20.0.dist-info/METADATA,sha256=J0jlBV5Gco4ONtZm_cOAEIAKc06-ChlLrK6TJ_tiAwc,9067
-openepd-6.20.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-openepd-6.20.0.dist-info/RECORD,,
+openepd-6.21.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openepd-6.21.0.dist-info/METADATA,sha256=5zzo-Y9jYVGStwGi6qPaqnxdc1eXKibPA8la_MuXInc,9827
+openepd-6.21.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+openepd-6.21.0.dist-info/RECORD,,