hdx-python-api 6.4.3__tar.gz → 6.4.5__tar.gz

{hdx_python_api-6.4.3 → hdx_python_api-6.4.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hdx-python-api
-Version: 6.4.3
+Version: 6.4.5
 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
@@ -26,7 +26,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.8
 Requires-Dist: ckanapi>=4.8
-Requires-Dist: defopt>=6.4.0
+Requires-Dist: defopt>=7.0.0
 Requires-Dist: email-validator
 Requires-Dist: hdx-python-country>=3.9.4
 Requires-Dist: hdx-python-utilities>=3.8.7

{hdx_python_api-6.4.3 → hdx_python_api-6.4.5}/documentation/index.md

@@ -34,6 +34,7 @@ upload your datasets to HDX.
     -   [User Management](#user-management)
     -   [Organization Management](#organization-management)
     -   [Vocabulary Management](#vocabulary-management)
+    -   [Pipeline State](#pipeline-state)
 -   [Working Examples](#working-examples)
 -   [Project Framework](#project-framework)
 -   [IDMC Example](#idmc-example)
@@ -52,6 +53,8 @@ The library has detailed API documentation which can be found in the menu at the
 
 
 ## Breaking Changes
+From 6.4.5, fix for changes in dependency defopt 7.0.0
+
 From 6.2.8, fix mark_data_updated which was broken due to an error in
 dataset_update_filestore_resource in which timezone information was
 incorrectly added to the iso formatted string
@@ -1088,6 +1091,51 @@ If you want to add a list of tags, you do it as follows:
 
     vocabulary.add_tags(["TAG","TAG","TAG"...])
 
+## Pipeline State
+
+The HDXState class allows the reading and writing of state to a given dataset. Input
+and output state transformations can be supplied in read_fn and write_fn
+respectively. The input state transformation takes in a string while the output
+transformation outputs a string. It is used as follows:
+
+        with temp_dir(folder="test_state") as tmpdir:
+            statepath = join(tmpdir, statefile)
+            copyfile(join(statefolder, statefile), statepath)
+            date1 = datetime(2020, 9, 23, 0, 0, tzinfo=timezone.utc)
+            date2 = datetime(2022, 5, 12, 10, 15, tzinfo=timezone.utc)
+            with HDXState(
+                "test_dataset", tmpdir, parse_date, iso_string_from_datetime
+            ) as state:
+                assert state.get() == date1
+                state.set(date2)
+            with HDXState(
+                "test_dataset", tmpdir, parse_date, iso_string_from_datetime
+            ) as state:
+                assert state.get() == date2.replace(hour=0, minute=0)
+
+            with HDXState(
+                "test_dataset",
+                tmpdir,
+                HDXState.dates_str_to_country_date_dict,
+                HDXState.country_date_dict_to_dates_str,
+            ) as state:
+                state_dict = state.get()
+                assert state_dict == {"DEFAULT": date1}
+                state_dict["AFG"] = date2
+                state.set(state_dict)
+            with HDXState(
+                "test_dataset",
+                tmpdir,
+                HDXState.dates_str_to_country_date_dict,
+                HDXState.country_date_dict_to_dates_str,
+            ) as state:
+                state_dict = state.get()
+                assert state_dict == {
+                    "DEFAULT": date1,
+                    "AFG": date2.replace(hour=0, minute=0),
+                }
+
+
 # Working Examples
 
 For a working example of downloading data in a dataset on HDX, see

{hdx_python_api-6.4.3 → hdx_python_api-6.4.5}/pyproject.toml

@@ -35,7 +35,7 @@ requires-python = ">=3.8"
 
 dependencies = [
     "ckanapi>=4.8",
-    "defopt>=6.4.0",
+    "defopt>=7.0.0",
     "email_validator",
     "hdx-python-country>=3.9.4",
     "hdx-python-utilities>=3.8.7",

{hdx_python_api-6.4.3 → hdx_python_api-6.4.5}/requirements.txt

@@ -16,7 +16,7 @@ backrefs==5.8
     # via mkdocs-material
 cachetools==5.5.2
     # via google-auth
-certifi==2025.4.26
+certifi==2025.6.15
     # via requests
 cfgv==3.4.0
     # via pre-commit
@@ -26,15 +26,15 @@ charset-normalizer==3.4.2
     # via requests
 ckanapi==4.8
     # via hdx-python-api (pyproject.toml)
-click==8.1.8
+click==8.2.1
     # via
     #   mkdocs
     #   typer
 colorama==0.4.6
     # via mkdocs-material
-coverage==7.8.1
+coverage==7.9.1
     # via pytest-cov
-defopt==6.4.0
+defopt==7.0.0
     # via hdx-python-api (pyproject.toml)
 distlib==0.3.9
     # via virtualenv
@@ -56,7 +56,7 @@ frictionless==5.18.1
     # via hdx-python-utilities
 ghp-import==2.1.0
     # via mkdocs
-google-auth==2.40.2
+google-auth==2.40.3
     # via
     #   google-auth-oauthlib
     #   gspread
@@ -72,7 +72,7 @@ hdx-python-utilities==3.8.7
     #   hdx-python-country
 humanize==4.12.3
     # via frictionless
-identify==2.6.10
+identify==2.6.12
     # via pre-commit
 idna==3.10
     # via
@@ -96,7 +96,7 @@ jsonlines==4.0.0
     # via hdx-python-utilities
 jsonpath-ng==1.7.0
     # via libhxl
-jsonschema==4.23.0
+jsonschema==4.24.0
     # via
     #   frictionless
     #   tableschema-to-template
@@ -117,7 +117,7 @@ markdown==3.8
     #   pymdown-extensions
 markdown-it-py==3.0.0
     # via rich
-marko==2.1.3
+marko==2.1.4
     # via frictionless
 markupsafe==3.0.2
     # via
@@ -129,7 +129,7 @@ mergedeep==1.3.4
     # via
     #   mkdocs
     #   mkdocs-get-deps
-mkapi==4.4.0
+mkapi==4.4.1
     # via hdx-python-api (pyproject.toml)
 mkdocs==1.6.1
     # via
@@ -166,7 +166,9 @@ platformdirs==4.3.8
     #   mkdocs-get-deps
     #   virtualenv
 pluggy==1.6.0
-    # via pytest
+    # via
+    #   pytest
+    #   pytest-cov
 ply==3.11
     # via
     #   jsonpath-ng
@@ -181,26 +183,27 @@ pyasn1==0.6.1
     #   rsa
 pyasn1-modules==0.4.2
     # via google-auth
-pydantic==2.11.5
+pydantic==2.11.7
     # via frictionless
 pydantic-core==2.33.2
     # via pydantic
 pygments==2.19.1
     # via
     #   mkdocs-material
+    #   pytest
     #   rich
 pymdown-extensions==10.15
     # via mkdocs-material
 pyphonetics==0.5.3
     # via hdx-python-utilities
-pytest==8.3.5
+pytest==8.4.0
     # via
     #   hdx-python-api (pyproject.toml)
     #   pytest-check
     #   pytest-cov
 pytest-check==2.5.3
     # via hdx-python-api (pyproject.toml)
-pytest-cov==6.1.1
+pytest-cov==6.2.1
     # via hdx-python-api (pyproject.toml)
 python-dateutil==2.9.0.post0
     # via
@@ -233,7 +236,7 @@ referencing==0.36.2
     # via
     #   jsonschema
     #   jsonschema-specifications
-requests==2.32.3
+requests==2.32.4
     # via
     #   hdx-python-api (pyproject.toml)
     #   ckanapi
@@ -256,9 +259,11 @@ rpds-py==0.25.1
     #   referencing
 rsa==4.9.1
     # via google-auth
-ruamel-yaml==0.18.10
+ruamel-yaml==0.18.14
     # via hdx-python-utilities
-setuptools==80.8.0
+ruamel-yaml-clib==0.2.12
+    # via ruamel-yaml
+setuptools==80.9.0
     # via ckanapi
 shellingham==1.5.4
     # via typer
@@ -274,7 +279,7 @@ six==1.17.0
     #   sphinxcontrib-napoleon
 sphinxcontrib-napoleon==0.7
     # via defopt
-structlog==25.3.0
+structlog==25.4.0
     # via libhxl
 tableschema-to-template==0.0.13
     # via hdx-python-utilities
@@ -284,11 +289,11 @@ tenacity==9.1.2
     # via hdx-python-country
 text-unidecode==1.3
     # via python-slugify
-typeguard==4.4.2
+typeguard==4.4.3
     # via inflect
-typer==0.15.4
+typer==0.16.0
     # via frictionless
-typing-extensions==4.13.2
+typing-extensions==4.14.0
     # via
     #   frictionless
     #   pydantic
@@ -314,7 +319,7 @@ watchdog==6.0.0
     # via mkdocs
 wheel==0.45.1
     # via libhxl
-xlrd==2.0.1
+xlrd==2.0.2
     # via hdx-python-utilities
 xlrd3==1.1.0
     # via libhxl

{hdx_python_api-6.4.3 → hdx_python_api-6.4.5}/src/hdx/api/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '6.4.3'
-__version_tuple__ = version_tuple = (6, 4, 3)
+__version__ = version = '6.4.5'
+__version_tuple__ = version_tuple = (6, 4, 5)

{hdx_python_api-6.4.3 → hdx_python_api-6.4.5}/src/hdx/api/utilities/hdx_error_handler.py

@@ -1,4 +1,5 @@
 import logging
+from os import getenv
 from typing import Any, Tuple
 
 from hdx.data.dataset import Dataset
@@ -19,17 +20,24 @@ class HDXErrorHandler(ErrorHandler):
 
     Args:
         should_exit_on_error (bool): Whether to exit with a 1 code if there are errors. Default is False.
-        write_to_hdx (bool): Whether to write errors to HDX resources. Default is False.
+        write_to_hdx (Any): Whether to write errors to HDX resources. Default is None (write errors).
 
     """
 
     def __init__(
         self,
         should_exit_on_error: bool = False,
-        write_to_hdx: bool = False,
+        write_to_hdx: Any = None,
     ):
         super().__init__(should_exit_on_error)
-        self._write_to_hdx = write_to_hdx
+        if write_to_hdx is None:
+            write_to_hdx = getenv("ERR_TO_HDX", True)
+        if write_to_hdx in (False, 0, "false", "False", "FALSE", "N", "n", ""):
+            self._write_to_hdx = False
+            logger.info("Errors won't be written to HDX")
+        else:
+            self._write_to_hdx = True
+            logger.info("Errors will be written to HDX")
         self.shared_errors["hdx_error"] = {}
 
     @staticmethod

{hdx_python_api-6.4.3 → hdx_python_api-6.4.5}/src/hdx/facades/infer_arguments.py

@@ -37,10 +37,12 @@ def facade(projectmainfn: Callable[[Any], None], **kwargs: Any):
     #
 
     parsed_main_doc = defopt._parse_docstring(getdoc(projectmainfn))
-    main_doc = [f"{parsed_main_doc.first_line}\n\nArgs:"]
-    no_main_params = len(parsed_main_doc.params)
-    for param_name, param_info in parsed_main_doc.params.items():
-        main_doc.append(f"\n    {param_name} ({param_info.type}): {param_info.text}")
+    main_doc = [f"{parsed_main_doc.doc}\n\nArgs:"]
+    no_main_parameters = len(parsed_main_doc.parameters)
+    for param_name, param_info in parsed_main_doc.parameters.items():
+        main_doc.append(
+            f"\n    {param_name} ({param_info.annotation}): {param_info.doc}"
+        )
     create_config_doc = getdoc(Configuration.create)
     kwargs_index = create_config_doc.index("**kwargs")
     kwargs_index = create_config_doc.index("\n", kwargs_index)
@@ -54,13 +56,13 @@ def facade(projectmainfn: Callable[[Any], None], **kwargs: Any):
         param_names.append(str(param))
 
     parsed_main_doc = defopt._parse_docstring(main_doc)
-    main_doc = [f"{parsed_main_doc.first_line}\n\nArgs:"]
+    main_doc = [f"{parsed_main_doc.doc}Args:"]
     count = 0
-    for param_name, param_info in parsed_main_doc.params.items():
-        param_type = param_info.type
+    for param_name, param_info in parsed_main_doc.parameters.items():
+        param_type = param_info.annotation
         if param_type == "dict":
             continue
-        if count < no_main_params:
+        if count < no_main_parameters:
             count += 1
         else:
             if param_type == "str":
@@ -73,7 +75,7 @@ def facade(projectmainfn: Callable[[Any], None], **kwargs: Any):
                     "Configuration.create has new parameter with unknown type!"
                 )
             param_names.append(f"{param_name}: {param_type} = {default}")
-        main_doc.append(f"\n    {param_name} ({param_type}): {param_info.text}")
+        main_doc.append(f"\n    {param_name} ({param_type}): {param_info.doc}")
     main_doc = "".join(main_doc)
 
     projectmainname = projectmainfn.__name__

{hdx_python_api-6.4.3 → hdx_python_api-6.4.5}/tests/hdx/api/utilities/test_hdx_error_handler.py

@@ -12,9 +12,35 @@ setup_logging()
 
 class TestHDXErrorHandler:
     def test_hdx_error_handler(self, caplog):
+        error_handler = HDXErrorHandler()
+        assert error_handler._write_to_hdx is True
+        error_handler = HDXErrorHandler(write_to_hdx=None)
+        assert error_handler._write_to_hdx is True
+        error_handler = HDXErrorHandler(write_to_hdx="true")
+        assert error_handler._write_to_hdx is True
+        error_handler = HDXErrorHandler(write_to_hdx="Y")
+        assert error_handler._write_to_hdx is True
+        error_handler = HDXErrorHandler(write_to_hdx=True)
+        assert error_handler._write_to_hdx is True
+        error_handler = HDXErrorHandler(write_to_hdx=1)
+        assert error_handler._write_to_hdx is True
+        error_handler = HDXErrorHandler(write_to_hdx="")
+        assert error_handler._write_to_hdx is False
+        error_handler = HDXErrorHandler(write_to_hdx="false")
+        assert error_handler._write_to_hdx is False
+        error_handler = HDXErrorHandler(write_to_hdx="FALSE")
+        assert error_handler._write_to_hdx is False
+        error_handler = HDXErrorHandler(write_to_hdx="n")
+        assert error_handler._write_to_hdx is False
+        error_handler = HDXErrorHandler(write_to_hdx=False)
+        assert error_handler._write_to_hdx is False
+        error_handler = HDXErrorHandler(write_to_hdx=0)
+        assert error_handler._write_to_hdx is False
         with pytest.raises(SystemExit):
             with caplog.at_level(logging.ERROR):
-                with HDXErrorHandler(should_exit_on_error=True) as errors:
+                with HDXErrorHandler(
+                    should_exit_on_error=True, write_to_hdx=False
+                ) as errors:
                     errors.add_message(
                         "pipeline1",
                         "dataset1",