openepd 5.2.0__py3-none-any.whl → 5.3.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 = "5.2.0"
+VERSION = "5.3.0"

openepd/api/average_dataset/generic_estimate_sync_api.py

@@ -21,7 +21,7 @@ from openepd.api.base_sync_client import BaseApiMethodGroup
 from openepd.api.common import StreamingListResponse, paging_meta_from_v1_api
 from openepd.api.dto.common import BaseMeta, OpenEpdApiResponse
 from openepd.api.dto.meta import PagingMetaMixin
-from openepd.api.utils import encode_path_param
+from openepd.api.utils import encode_path_param, remove_none_id_fields
 from openepd.model.generic_estimate import (
     GenericEstimate,
     GenericEstimatePreview,
@@ -57,26 +57,33 @@ class GenericEstimateApi(BaseApiMethodGroup):
 
     @overload
     def post_with_refs(
-        self, ge: GenericEstimateWithDeps, with_response: Literal[True]
+        self, ge: GenericEstimateWithDeps, with_response: Literal[True], exclude_defaults: bool = True
     ) -> tuple[GenericEstimate, Response]: ...
 
     @overload
-    def post_with_refs(self, ge: GenericEstimateWithDeps, with_response: Literal[False] = False) -> GenericEstimate: ...
+    def post_with_refs(
+        self, ge: GenericEstimateWithDeps, with_response: Literal[False] = False, exclude_defaults: bool = True
+    ) -> GenericEstimate: ...
 
     def post_with_refs(
-        self, ge: GenericEstimateWithDeps, with_response: bool = False
+        self, ge: GenericEstimateWithDeps, with_response: bool = False, exclude_defaults: bool = True
     ) -> GenericEstimate | tuple[GenericEstimate, Response]:
         """
         Post an GenericEstimate with references.
 
         :param ge: GenericEstimate
         :param with_response: return the response object togather with the GenericEstimate
+        :param exclude_defaults: If True, fields with default values are excluded from the payload
         :return: GenericEstimate alone, or GenericEstimate with HTTP Response object depending on parameter
         """
+        data = ge.to_serializable(exclude_unset=True, exclude_defaults=exclude_defaults, by_alias=True)
+        if exclude_defaults is False:
+            # Remove 'id' fields with None values, as 'id' cannot be None
+            data = remove_none_id_fields(data)
         response = self._client.do_request(
             "patch",
             "/generic_estimates/post_with_refs",
-            json=ge.to_serializable(exclude_unset=True, exclude_defaults=True, by_alias=True),
+            json=data,
         )
         content = response.json()
         if with_response:

openepd/api/epd/sync_api.py

@@ -20,7 +20,7 @@ from requests import Response
 from openepd.api.base_sync_client import BaseApiMethodGroup
 from openepd.api.common import StreamingListResponse
 from openepd.api.epd.dto import EpdSearchResponse, EpdStatisticsResponse, StatisticsDto
-from openepd.api.utils import encode_path_param
+from openepd.api.utils import encode_path_param, remove_none_id_fields
 from openepd.model.epd import Epd
 
 
@@ -106,23 +106,32 @@ class EpdApi(BaseApiMethodGroup):
         return self.get_statistics_raw(omf).payload
 
     @overload
-    def post_with_refs(self, epd: Epd, with_response: Literal[True]) -> tuple[Epd, Response]: ...
+    def post_with_refs(
+        self, epd: Epd, with_response: Literal[True], exclude_defaults: bool = True
+    ) -> tuple[Epd, Response]: ...
 
     @overload
-    def post_with_refs(self, epd: Epd, with_response: Literal[False] = False) -> Epd: ...
+    def post_with_refs(self, epd: Epd, with_response: Literal[False] = False, exclude_defaults: bool = True) -> Epd: ...
 
-    def post_with_refs(self, epd: Epd, with_response: bool = False) -> Epd | tuple[Epd, Response]:
+    def post_with_refs(
+        self, epd: Epd, with_response: bool = False, exclude_defaults: bool = True
+    ) -> Epd | tuple[Epd, Response]:
         """
         Post an EPD with references.
 
         :param epd: EPD
         :param with_response: return the response object togather with the EPD
+        :param exclude_defaults: If True, fields with default values are excluded from the payload
         :return: EPD or EPD with HTTP Response object depending on parameter
         """
+        epd_data = epd.to_serializable(exclude_unset=True, exclude_defaults=exclude_defaults, by_alias=True)
+        if exclude_defaults is False:
+            # Remove 'id' fields with None values, as 'id' cannot be None
+            epd_data = remove_none_id_fields(epd_data)
         response = self._client.do_request(
             "patch",
             "/epds/post-with-refs",
-            json=epd.to_serializable(exclude_unset=True, exclude_defaults=True, by_alias=True),
+            json=epd_data,
         )
         content = response.json()
         if with_response:

openepd/api/utils.py

@@ -26,3 +26,43 @@ def encode_path_param(value: str) -> str:
     :return: encoded value
     """
     return quote(value, safe="")
+
+
+def remove_none_id_fields(d: dict) -> dict:
+    """
+    Remove any key 'id' with a None value from the dictionary, including nested dicts.
+
+    :param d: the dict which may contain 'id' keys with None values.
+    :return: a new dict with 'id' keys that have None values removed.
+
+    :note:
+        - This function does not modify the original dictionary (no side effects).
+        - It returns a new dictionary with the necessary modifications applied.
+
+    :example:
+        >>> data = {
+        ...     "id": None,
+        ...     "name": "item1",
+        ...     "details": {
+        ...         "id": None,
+        ...         "category": "tools",
+        ...         "nested": {
+        ...             "id": None,
+        ...             "value": 42
+        ...         }
+        ...     }
+        ... }
+        >>> remove_none_id_fields(data)
+        {'name': 'item1', 'details': {'category': 'tools', 'nested': {'value': 42}}}
+    """
+    if not isinstance(d, dict):
+        return d
+
+    cleaned_dict = {}
+    for k, v in d.items():
+        if isinstance(v, dict):
+            v = remove_none_id_fields(v)
+        if not (k == "id" and v is None):
+            cleaned_dict[k] = v
+
+    return cleaned_dict

{openepd-5.2.0.dist-info → openepd-5.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openepd
-Version: 5.2.0
+Version: 5.3.0
 Summary: Python library to work with OpenEPD format
 Home-page: https://github.com/cchangelabs/openepd
 License: Apache-2.0

{openepd-5.2.0.dist-info → openepd-5.3.0.dist-info}/RECORD

@@ -1,8 +1,8 @@
 openepd/__init__.py,sha256=Shkfh0Kun0YRhmRDw7LkUj2eQL3X-HnP55u2THOEALw,794
-openepd/__version__.py,sha256=kbk6lMDGVEMCkU1Pk1p1wyGQXEfbVXyh26UjUL-A4YI,638
+openepd/__version__.py,sha256=eEVqmdbsGDJ4vyFA7va4C2zZ4rWy5ZZzKevZvLZTPtQ,638
 openepd/api/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
 openepd/api/average_dataset/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
-openepd/api/average_dataset/generic_estimate_sync_api.py,sha256=DM7i8gugUIEAutEsakEUxFjwgtKmcytkjvNAvfhVYUs,7690
+openepd/api/average_dataset/generic_estimate_sync_api.py,sha256=5dWtdyzs9WGO5-liQGZd0o5q0tSjoJrx1RCtjSnRrrk,8110
 openepd/api/average_dataset/industry_epd_sync_api.py,sha256=xoicuZdclf4BTBa2ndG1K2Aog-iZd7_jOqdDPZSCLq4,6286
 openepd/api/base_sync_client.py,sha256=IX-q6JdWLMqYHC-hKLXUFRPs-DZZ9Co0NRZ5pSAipAs,20992
 openepd/api/category/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
@@ -17,13 +17,13 @@ openepd/api/dto/mf.py,sha256=tjsxF6yJhnOrcOepNVHBn18pF-kXkBoUYfTQwOTaY2g,1994
 openepd/api/dto/params.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
 openepd/api/epd/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
 openepd/api/epd/dto.py,sha256=NZ76vfUkCEkwDibQd2QCEQP5DZms_NFc9tjoP-mcw3o,4874
-openepd/api/epd/sync_api.py,sha256=5wuPiM_zVciVtTvsGaaRdf7T6q2CUp7QMZCW0DAjQng,7072
+openepd/api/epd/sync_api.py,sha256=EY9KVz8yDgmjgLzWWh2B3VobNswd9fZmfDFkiJTxog0,7522
 openepd/api/errors.py,sha256=Iipd0QW2tbhUu_UjUbmiFWgmrPVgOFHc3uxZN-SX-g4,2868
 openepd/api/pcr/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
 openepd/api/pcr/sync_api.py,sha256=Riu77h8uLJngKpITOiXYmO7mzjAHpYskUJ6ynyfNG78,1557
 openepd/api/sync_client.py,sha256=IurnhZrkBQoQIbbfon6TPuhjGpAV_CSTJNeXjIiN0QI,3105
 openepd/api/test/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
-openepd/api/utils.py,sha256=FSY2W8zTXGTvJAJACMi4nibpo-9m1HXkTCH8kdAYlzQ,875
+openepd/api/utils.py,sha256=9kdWbJ-m0IqsrkPQpGkILIQlR1WPd9rRlko-ymj9gtI,2092
 openepd/bundle/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
 openepd/bundle/base.py,sha256=mOt3h3MuQyc1yunp9u6_CVYDtSdWQHZcx8cNfbNkqoY,6869
 openepd/bundle/model.py,sha256=yICEHl7ZWDXHGx4rhFomCwa-ganjUtykyj_fpWw_6OI,2446
@@ -133,7 +133,7 @@ openepd/model/validation/quantity.py,sha256=8LbSn-Gfo6r1j6AKDjzPnt_9dwyXMFmN5Uao
 openepd/model/versioning.py,sha256=R_zm6rCrgF3vlJQYbpyWhirdS_Oek16cv_mvZmpuE8I,4473
 openepd/patch_pydantic.py,sha256=xrkzblatmU9HBzukWkp1cPq9ZSuohoz1p0pQqVKSlKs,4122
 openepd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openepd-5.2.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openepd-5.2.0.dist-info/METADATA,sha256=Ty91Z75VePUQGEPSLaD7hJROLHkCJ_6u2ueFFZ6IcC8,8996
-openepd-5.2.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-openepd-5.2.0.dist-info/RECORD,,
+openepd-5.3.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openepd-5.3.0.dist-info/METADATA,sha256=twGr4uGcA4Rn0osNRGYw0IdWeC53yVy5NlbzhZNLZ6c,8996
+openepd-5.3.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+openepd-5.3.0.dist-info/RECORD,,