hdx-python-api 6.6.8__py3-none-any.whl → 6.6.9__py3-none-any.whl

hdx/api/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '6.6.8'
-__version_tuple__ = version_tuple = (6, 6, 8)
+__version__ = version = '6.6.9'
+__version_tuple__ = version_tuple = (6, 6, 9)
 
 __commit_id__ = commit_id = None

hdx/data/resource.py

@@ -1,5 +1,6 @@
 """Resource class containing all logic for creating, checking, and updating resources."""
 
+import json
 import logging
 from collections.abc import Sequence
 from datetime import datetime
@@ -33,6 +34,9 @@ class Resource(HDXObject):
     """
 
     _formats_dict = None
+    _valid_data_dictionary_types = frozenset(
+        {"text", "numeric", "date", "timestamp without time zone"}
+    )
 
     def __init__(
         self,
@@ -263,6 +267,56 @@ class Resource(HDXObject):
         self.data["format"] = file_format
         return file_format
 
+    def get_hdx_data_dictionary(self) -> list[dict] | None:
+        """Get the resource's data dictionary (column definitions)
+
+        Returns:
+            List of column definition dictionaries or None if not set
+        """
+        data_dictionary = self.data.get("hdx_data_dictionary")
+        if data_dictionary is None:
+            return None
+        if isinstance(data_dictionary, str):
+            return json.loads(data_dictionary)
+        return data_dictionary
+
+    def set_hdx_data_dictionary(self, data_dictionary: Sequence[dict]) -> None:
+        """Set the resource's data dictionary (column definitions). Each column
+        definition must be a dict with non-empty string values for field
+        (column name in the CSV file), label (human-readable column label) and
+        description (human-readable description of the column). If present,
+        data_type must be one of the PostgreSQL types produced by DataPusher+
+        (text, numeric, date, timestamp without time zone).
+
+        Args:
+            data_dictionary: Sequence of column definition dictionaries
+
+        Returns:
+            None
+        """
+        if not data_dictionary:
+            raise HDXError("hdx_data_dictionary must be a non-empty list!")
+        for i, column in enumerate(data_dictionary):
+            if not isinstance(column, dict):
+                raise HDXError(f"hdx_data_dictionary[{i}] must be a dict!")
+            for required_key in ("field", "label", "description"):
+                value = column.get(required_key)
+                if not isinstance(value, str) or not value.strip():
+                    raise HDXError(
+                        f"hdx_data_dictionary[{i}] is missing a non-empty '{required_key}'!"
+                    )
+            if "data_type" in column:
+                data_type = column["data_type"]
+                if data_type not in self._valid_data_dictionary_types:
+                    valid_types = ", ".join(sorted(self._valid_data_dictionary_types))
+                    raise HDXError(
+                        f"hdx_data_dictionary[{i}] has invalid 'data_type' "
+                        f"'{data_type}'! Must be one of: {valid_types}"
+                    )
+        self.data["hdx_data_dictionary"] = json.dumps(
+            data_dictionary, separators=(",", ":")
+        )
+
     def clean_format(self) -> str:
         """Clean the resource's format, setting it to None if it is invalid and
         cannot be mapped

{hdx_python_api-6.6.8.dist-info → hdx_python_api-6.6.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: hdx-python-api
-Version: 6.6.8
+Version: 6.6.9
 Summary: HDX Python API for interacting with the Humanitarian Data Exchange
 Project-URL: Homepage, https://github.com/OCHA-DAP/hdx-python-api
 Author: Michael Rans
@@ -28,8 +28,8 @@ Requires-Python: >=3.10
 Requires-Dist: ckanapi>=4.11
 Requires-Dist: defopt>=7.0.0
 Requires-Dist: email-validator
-Requires-Dist: hdx-python-country>=4.1.1
-Requires-Dist: hdx-python-utilities>=4.0.8
+Requires-Dist: hdx-python-country>=4.1.3
+Requires-Dist: hdx-python-utilities>=4.1.2
 Requires-Dist: makefun
 Requires-Dist: requests
 Provides-Extra: docs

{hdx_python_api-6.6.8.dist-info → hdx_python_api-6.6.9.dist-info}/RECORD

@@ -1,5 +1,5 @@
 hdx/api/__init__.py,sha256=11ozJKiUsqDCZ3_mcAHhGYUyGK_Unl54djVSBBExFB4,59
-hdx/api/_version.py,sha256=DuBvygFq7Ca-heE19aRqV-dGslR55qXsxEXRXjW5FNM,520
+hdx/api/_version.py,sha256=DZ0RWsb-nM4U2OMHNx7xq0IT_NuQKLA1g5wIx_XHwr4,520
 hdx/api/configuration.py,sha256=9WvuVI-3th2Dv70_t_4VoyrlJwB_9qUSN5_zUKbp4sQ,23805
 hdx/api/hdx_base_configuration.yaml,sha256=9yJYroZwoyMQo6tcxGfWHWvYahnTma7Szx0J5Z378z4,2173
 hdx/api/locations.py,sha256=blnqOjEASvh0mWgmo2iEE7ES_xOuRwQo3fOMqTPV_P0,4139
@@ -14,7 +14,7 @@ hdx/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hdx/data/dataset.py,sha256=0gS7tQSswTgG0g8YeXg0FL8pFVkocBQSRPFpQAurN00,99455
 hdx/data/hdxobject.py,sha256=_jlwYjb_CcjaXsTXObknMfq-OiNOcpJfLJ9b1vKV1Zo,27494
 hdx/data/organization.py,sha256=HGopFsCYOWrR7sUtZzZSXq6wLFw4djus2gzg6yNXOqc,12296
-hdx/data/resource.py,sha256=YcxGzKuFduLZIOnCvo-zcwJfnTGOmnvtDeFr2xKeOM4,35647
+hdx/data/resource.py,sha256=SBAEou9Fj5sgpfoDmQ6j33W0srMMmhlsj00hiTuW86Y,38097
 hdx/data/resource_matcher.py,sha256=Yzk9pWa4zk1p09m6zcZMj0XZf5Y16Pa3KToOdUt7rP8,4247
 hdx/data/resource_view.py,sha256=GcYkh0iDAe6_m2ErY_A6i3Z7ZFX949eGt1TLnLZv_8s,7346
 hdx/data/showcase.py,sha256=vnRZ45xd9Ct65eFQkWZtMIJPFifZfKOrH4obO5D5Pvc,14062
@@ -24,7 +24,7 @@ hdx/facades/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hdx/facades/infer_arguments.py,sha256=DvyDuozfOPmoaV7HjhQySojGIrMWW9nos31auQBVVl8,4032
 hdx/facades/keyword_arguments.py,sha256=aVapHCfqBO6H7xxBgTdK9ISdgrBFsNypPDWihfQ3edU,1125
 hdx/facades/simple.py,sha256=QWsBkaHG_UM6X3Zu2u3LWVOQzeR24q-EUClrfsL_mkM,1064
-hdx_python_api-6.6.8.dist-info/METADATA,sha256=tRdOttf0O-eRc7iASB0HkCahGiC4dzf5SIVCCv8VHxw,4946
-hdx_python_api-6.6.8.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
-hdx_python_api-6.6.8.dist-info/licenses/LICENSE,sha256=wc-4GpMn-ODs-U_bTe1YCiPVgvcjzrpYOx2wPuyAeII,1079
-hdx_python_api-6.6.8.dist-info/RECORD,,
+hdx_python_api-6.6.9.dist-info/METADATA,sha256=H29ZAlNGFdS46-ucNToWqy68nIrHQkcjULochC1Ijao,4946
+hdx_python_api-6.6.9.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+hdx_python_api-6.6.9.dist-info/licenses/LICENSE,sha256=wc-4GpMn-ODs-U_bTe1YCiPVgvcjzrpYOx2wPuyAeII,1079
+hdx_python_api-6.6.9.dist-info/RECORD,,

{hdx_python_api-6.6.8.dist-info → hdx_python_api-6.6.9.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.29.0
+Generator: hatchling 1.32.0
 Root-Is-Purelib: true
 Tag: py3-none-any