hdx-python-api 6.3.3__tar.gz → 6.3.5__tar.gz

{hdx_python_api-6.3.3 → hdx_python_api-6.3.5}/.config/pre-commit-config.yaml

@@ -2,13 +2,13 @@ default_language_version:
     python: python3.12
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-ast
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.4
+    rev: v0.7.0
     hooks:
       # Run the linter.
       - id: ruff
@@ -17,7 +17,7 @@ repos:
       - id: ruff-format
         args: [--config, .config/ruff.toml]
   - repo: https://github.com/astral-sh/uv-pre-commit
-    rev: 0.4.5
+    rev: 0.4.24
     hooks:
       # Run the pip compile
       - id: pip-compile

{hdx_python_api-6.3.3 → hdx_python_api-6.3.5}/PKG-INFO

@@ -1,11 +1,10 @@
 Metadata-Version: 2.3
 Name: hdx-python-api
-Version: 6.3.3
+Version: 6.3.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
 License: MIT
-License-File: LICENSE
 Keywords: API,CKAN,HDX,humanitarian data exchange
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
@@ -28,13 +27,10 @@ Requires-Python: >=3.8
 Requires-Dist: ckanapi>=4.8
 Requires-Dist: defopt>=6.4.0
 Requires-Dist: email-validator
-Requires-Dist: hdx-python-country>=3.7.8
-Requires-Dist: hdx-python-utilities>=3.7.3
-Requires-Dist: libhxl>=5.2.1
+Requires-Dist: hdx-python-country>=3.8.3
+Requires-Dist: hdx-python-utilities>=3.7.4
+Requires-Dist: libhxl>=5.2.2
 Requires-Dist: makefun
-Requires-Dist: ndg-httpsclient
-Requires-Dist: pyasn1
-Requires-Dist: pyopenssl
 Requires-Dist: quantulum3
 Requires-Dist: requests
 Provides-Extra: dev

{hdx_python_api-6.3.3 → hdx_python_api-6.3.5}/pyproject.toml

@@ -37,13 +37,10 @@ dependencies = [
     "ckanapi>=4.8",
     "defopt>=6.4.0",
     "email_validator",
-    "hdx-python-country>=3.7.8",
-    "hdx-python-utilities>=3.7.3",
-    "libhxl>=5.2.1",
+    "hdx-python-country>=3.8.3",
+    "hdx-python-utilities>=3.7.4",
+    "libhxl>=5.2.2",
     "makefun",
-    "ndg-httpsclient",
-    "pyasn1",
-    "pyOpenSSL",
     "quantulum3",
     "requests",
 ]
@@ -97,6 +94,9 @@ run = """
        --cov-report=lcov --cov-report=term-missing
        """
 
+[tool.hatch.envs.hatch-static-analysis]
+dependencies = ["ruff==0.7.0"]
+
 [tool.hatch.envs.hatch-static-analysis.scripts]
 format-check = ["ruff format --config .config/ruff.toml --check --diff {args:.}",]
 format-fix = ["ruff format --config .config/ruff.toml {args:.}",]

{hdx_python_api-6.3.3 → hdx_python_api-6.3.5}/requirements.txt

@@ -12,27 +12,23 @@ cachetools==5.5.0
     # via google-auth
 certifi==2024.8.30
     # via requests
-cffi==1.17.1
-    # via cryptography
 cfgv==3.4.0
     # via pre-commit
 chardet==5.2.0
     # via frictionless
-charset-normalizer==3.3.2
+charset-normalizer==3.4.0
     # via requests
 ckanapi==4.8
     # via hdx-python-api (pyproject.toml)
 click==8.1.7
     # via typer
-coverage==7.6.1
+coverage==7.6.4
     # via pytest-cov
-cryptography==43.0.1
-    # via pyopenssl
 defopt==6.4.0
     # via hdx-python-api (pyproject.toml)
-distlib==0.3.8
+distlib==0.3.9
     # via virtualenv
-dnspython==2.6.1
+dnspython==2.7.0
     # via email-validator
 docopt==0.6.2
     # via
@@ -42,74 +38,72 @@ docutils==0.21.2
     # via defopt
 email-validator==2.2.0
     # via hdx-python-api (pyproject.toml)
-et-xmlfile==1.1.0
+et-xmlfile==2.0.0
     # via openpyxl
-filelock==3.15.4
+filelock==3.16.1
     # via virtualenv
-frictionless==5.17.1
+frictionless==5.18.0
     # via hdx-python-utilities
-google-auth==2.34.0
+google-auth==2.36.0
     # via
     #   google-auth-oauthlib
     #   gspread
 google-auth-oauthlib==1.2.1
     # via gspread
-gspread==6.1.2
+gspread==6.1.4
     # via hdx-python-api (pyproject.toml)
-hdx-python-country==3.7.8
+hdx-python-country==3.8.3
     # via hdx-python-api (pyproject.toml)
-hdx-python-utilities==3.7.3
+hdx-python-utilities==3.7.4
     # via
     #   hdx-python-api (pyproject.toml)
     #   hdx-python-country
-humanize==4.10.0
+humanize==4.11.0
     # via frictionless
-identify==2.6.0
+identify==2.6.1
     # via pre-commit
-idna==3.8
+idna==3.10
     # via
     #   email-validator
     #   requests
 ijson==3.3.0
     # via hdx-python-utilities
-inflect==7.3.1
+inflect==7.4.0
     # via quantulum3
 iniconfig==2.0.0
     # via pytest
-isodate==0.6.1
+isodate==0.7.2
     # via frictionless
 jinja2==3.1.4
     # via frictionless
 jsonlines==4.0.0
     # via hdx-python-utilities
-jsonpath-ng==1.6.1
+jsonpath-ng==1.7.0
     # via libhxl
 jsonschema==4.23.0
     # via
     #   frictionless
     #   tableschema-to-template
-jsonschema-specifications==2023.12.1
+jsonschema-specifications==2024.10.1
     # via jsonschema
-libhxl==5.2.1
+libhxl==5.2.2
     # via
     #   hdx-python-api (pyproject.toml)
     #   hdx-python-country
 loguru==0.7.2
     # via hdx-python-utilities
-makefun==1.15.4
+makefun==1.15.6
     # via hdx-python-api (pyproject.toml)
 markdown-it-py==3.0.0
     # via rich
 marko==2.1.2
     # via frictionless
-markupsafe==2.1.5
+markupsafe==3.0.2
     # via jinja2
 mdurl==0.1.2
     # via markdown-it-py
 more-itertools==10.5.0
     # via inflect
-ndg-httpsclient==0.5.1
-    # via hdx-python-api (pyproject.toml)
 nodeenv==1.9.1
     # via pre-commit
 num2words==0.5.13
@@ -122,7 +116,7 @@ packaging==24.1
     # via pytest
 petl==1.7.15
     # via frictionless
-platformdirs==4.2.2
+platformdirs==4.3.6
     # via virtualenv
 pluggy==1.5.0
     # via pytest
@@ -132,35 +126,27 @@ ply==3.11
     #   libhxl
 pockets==0.9.1
     # via sphinxcontrib-napoleon
-pre-commit==3.8.0
+pre-commit==4.0.1
     # via hdx-python-api (pyproject.toml)
-pyasn1==0.6.0
+pyasn1==0.6.1
     # via
-    #   hdx-python-api (pyproject.toml)
-    #   ndg-httpsclient
     #   pyasn1-modules
     #   rsa
-pyasn1-modules==0.4.0
+pyasn1-modules==0.4.1
     # via google-auth
-pycparser==2.22
-    # via cffi
-pydantic==2.9.0
+pydantic==2.9.2
     # via frictionless
-pydantic-core==2.23.2
+pydantic-core==2.23.4
     # via pydantic
 pygments==2.18.0
     # via rich
-pyopenssl==24.2.1
-    # via
-    #   hdx-python-api (pyproject.toml)
-    #   ndg-httpsclient
 pyphonetics==0.5.3
     # via hdx-python-country
-pytest==8.3.2
+pytest==8.3.3
     # via
     #   hdx-python-api (pyproject.toml)
     #   pytest-cov
-pytest-cov==5.0.0
+pytest-cov==6.0.0
     # via hdx-python-api (pyproject.toml)
 python-dateutil==2.9.0.post0
     # via
@@ -200,9 +186,9 @@ requests-oauthlib==2.0.0
     # via google-auth-oauthlib
 rfc3986==2.0.0
     # via frictionless
-rich==13.8.0
+rich==13.9.4
     # via typer
-rpds-py==0.20.0
+rpds-py==0.21.0
     # via
     #   jsonschema
     #   referencing
@@ -210,20 +196,19 @@ rsa==4.9
     # via google-auth
 ruamel-yaml==0.18.6
     # via hdx-python-utilities
-ruamel-yaml-clib==0.2.8
+ruamel-yaml-clib==0.2.12
     # via ruamel-yaml
-setuptools==74.1.2
+setuptools==75.3.0
     # via ckanapi
 shellingham==1.5.4
     # via typer
-simpleeval==0.9.13
+simpleeval==1.0.3
     # via frictionless
 simplejson==3.19.3
     # via ckanapi
 six==1.16.0
     # via
     #   ckanapi
-    #   isodate
     #   pockets
     #   python-dateutil
     #   sphinxcontrib-napoleon
@@ -237,11 +222,13 @@ tableschema-to-template==0.0.13
     # via hdx-python-utilities
 tabulate==0.9.0
     # via frictionless
+tenacity==9.0.0
+    # via hdx-python-country
 text-unidecode==1.3
     # via python-slugify
-typeguard==4.3.0
+typeguard==4.4.1
     # via inflect
-typer==0.12.5
+typer==0.13.0
     # via frictionless
 typing-extensions==4.12.2
     # via
@@ -250,19 +237,17 @@ typing-extensions==4.12.2
     #   pydantic-core
     #   typeguard
     #   typer
-tzdata==2024.1
-    # via pydantic
 unidecode==1.3.8
     # via
     #   libhxl
     #   pyphonetics
-urllib3==2.2.2
+urllib3==2.2.3
     # via
     #   libhxl
     #   requests
 validators==0.34.0
     # via frictionless
-virtualenv==20.26.3
+virtualenv==20.27.1
     # via pre-commit
 wheel==0.44.0
     # via libhxl

{hdx_python_api-6.3.3 → hdx_python_api-6.3.5}/src/hdx/api/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '6.3.3'
-__version_tuple__ = version_tuple = (6, 3, 3)
+__version__ = version = '6.3.5'
+__version_tuple__ = version_tuple = (6, 3, 5)

{hdx_python_api-6.3.3 → hdx_python_api-6.3.5}/src/hdx/data/dataset.py

@@ -2960,3 +2960,38 @@ class Dataset(HDXObject):
             quickcharts=quickcharts,
             encoding=kwargs.get("encoding", None),
         )
+
+    def add_hapi_error(
+        self,
+        error_message: str,
+        resource_name: Optional[str] = None,
+        resource_id: Optional[str] = None,
+    ) -> bool:
+        """Writes error messages that were uncovered while processing data for
+        the HAPI database to a resource's metadata on HDX. If the resource
+        already has an error message, it is only overwritten if the two
+        messages are different.
+
+        Args:
+            error_message (str): Error(s) uncovered
+            resource_name (Optional[str]): Resource name. Defaults to None
+            resource_id (Optional[str]): Resource id. Defaults to None
+
+        Returns:
+            bool: True if a message was added, False if not
+        """
+        if resource_name is None and resource_id is None:
+            return False
+        resource = None
+        for res in self.get_resources():
+            if res["name"] == resource_name or res["id"] == resource_id:
+                resource = res
+                break
+        if not resource:
+            return False
+        resource_error = resource.get("qa_hapi_report")
+        if resource_error and resource_error == error_message:
+            return False
+        resource["qa_hapi_report"] = error_message
+        resource.update_in_hdx(operation="patch")
+        return True

hdx_python_api-6.3.5/tests/hdx/data/test_dataset_add_hapi_error.py

@@ -0,0 +1,71 @@
+import copy
+import json
+
+import pytest
+
+from . import MockResponse, dataset_data, dataset_resultdict, resources_data
+from hdx.api.configuration import Configuration
+from hdx.data.dataset import Dataset
+
+
+class TestDatasetAddHAPIError:
+    @pytest.fixture(scope="function")
+    def hapi_resource_update(self):
+        class MockSession:
+            @staticmethod
+            def post(url, data, headers, files, allow_redirects, auth=None):
+                datadict = json.loads(data.decode("utf-8"))
+                if "show" in url:
+                    resource_id = datadict["id"]
+                    resources_json = dataset_resultdict["resources"]
+                    if resource_id == "de6549d8-268b-4dfe-adaf-a4ae5c8510d5":
+                        resource_json = resources_json[0]
+                    elif resource_id == "3d777226-96aa-4239-860a-703389d16d1f":
+                        resource_json = resources_json[1]
+                    elif resource_id == "3d777226-96aa-4239-860a-703389d16d1g":
+                        resource_json = resources_json[2]
+                    else:
+                        return MockResponse(
+                            404,
+                            '{"success": false, "error": {"message": "TEST ERROR: Invalid id", "__type": "TEST ERROR: Invalid id Error"}, "help": "http://test-data.humdata.org/api/3/action/help_show?name=resource_patch"}',
+                        )
+                    result = json.dumps(resource_json)
+                    return MockResponse(
+                        200,
+                        '{"success": true, "result": %s, "help": "http://test-data.humdata.org/api/3/action/help_show?name=resource_create"}'
+                        % result,
+                    )
+                if "patch" not in url:
+                    return MockResponse(
+                        404,
+                        '{"success": false, "error": {"message": "TEST ERROR: Not patch", "__type": "TEST ERROR: Not Patch Error"}, "help": "http://test-data.humdata.org/api/3/action/help_show?name=resource_patch"}',
+                    )
+                result = json.dumps(datadict)
+                return MockResponse(
+                    200,
+                    '{"success": true, "result": %s, "help": "http://test-data.humdata.org/api/3/action/help_show?name=resource_patch"}'
+                    % result,
+                )
+
+        Configuration.read().remoteckan().session = MockSession()
+
+    def test_add_hapi_error(self, configuration, hapi_resource_update):
+        datasetdata = copy.deepcopy(dataset_data)
+        resourcesdata = copy.deepcopy(resources_data)
+        datasetdata["resources"] = resourcesdata
+        dataset = Dataset(datasetdata)
+        success = dataset.add_hapi_error(
+            error_message="test message",
+            resource_name="Resource1",
+        )
+        assert success is True
+        success = dataset.add_hapi_error(
+            error_message="test message",
+            resource_id="de6549d8-268b-4dfe-adaf-a4ae5c8510d5",
+        )
+        assert success is False
+        success = dataset.add_hapi_error(
+            error_message="test message 1",
+            resource_name="Resource1",
+        )
+        assert success is True