openepd 5.2.0__tar.gz → 5.3.0__tar.gz

{openepd-5.2.0 → openepd-5.3.0}/PKG-INFO

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

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

{openepd-5.2.0 → openepd-5.3.0}/src/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-5.2.0 → openepd-5.3.0}/src/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-5.2.0 → openepd-5.3.0}/src/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-5.3.0/src/openepd/api/utils.py

@@ -0,0 +1,68 @@
+#
+#  Copyright 2024 by C Change Labs Inc. www.c-change-labs.com
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+__all__ = ("encode_path_param",)
+
+from urllib.parse import quote
+
+
+def encode_path_param(value: str) -> str:
+    """
+    Encode a path parameter value.
+
+    :param value: parameter value
+    :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/src/openepd/api/utils.py

@@ -1,28 +0,0 @@
-#
-#  Copyright 2024 by C Change Labs Inc. www.c-change-labs.com
-#
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-#
-__all__ = ("encode_path_param",)
-
-from urllib.parse import quote
-
-
-def encode_path_param(value: str) -> str:
-    """
-    Encode a path parameter value.
-
-    :param value: parameter value
-    :return: encoded value
-    """
-    return quote(value, safe="")