hdx-python-utilities 3.6.1__tar.gz → 3.6.2__tar.gz

{hdx_python_utilities-3.6.1 → hdx_python_utilities-3.6.2}/.github/workflows/run-python-tests.yaml

@@ -4,6 +4,7 @@
 name: Run tests
 
 on:
+  workflow_dispatch: # add run button in github
   push:
     branches-ignore:
       - gh-pages

{hdx_python_utilities-3.6.1 → hdx_python_utilities-3.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hdx-python-utilities
-Version: 3.6.1
+Version: 3.6.2
 Summary: HDX Python Utilities for streaming tabular data, date and time handling and other helpful functions
 Project-URL: Homepage, https://github.com/OCHA-DAP/hdx-python-utilities
 Author-email: Michael Rans <rans@email.com>

{hdx_python_utilities-3.6.1 → hdx_python_utilities-3.6.2}/documentation/.readthedocs.yaml

@@ -1,7 +1,7 @@
 version: 2
 
 mkdocs:
-  configuration: mkdocs.yml
+  configuration: docs/mkdocs.yml
   fail_on_warning: false
 
 build:
@@ -13,5 +13,3 @@ build:
       - pip install --upgrade mkdocs
       - pip install pydoc-markdown
       - pydoc-markdown documentation/pydoc-markdown.yaml
-      - mv docs/content/* docs
-      - rmdir docs/content

{hdx_python_utilities-3.6.1 → hdx_python_utilities-3.6.2}/documentation/main.md

@@ -679,6 +679,27 @@ transformation outputs a string. It is used as follows:
             ) as state:
                 assert state.get() == date2.replace(hour=0, minute=0)
 
+            with State(
+                statepath,
+                State.dates_str_to_country_date_dict,
+                State.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 State(
+                statepath,
+                State.dates_str_to_country_date_dict,
+                State.country_date_dict_to_dates_str,
+            ) as state:
+                state_dict = state.get()
+                assert state_dict == {
+                    "DEFAULT": date1,
+                    "AFG": date2.replace(hour=0, minute=0),
+                }
+
+
 If run inside a GitHub Action, the saved state file could be committed to 
 GitHub so that on the next run the state is available in the repository.
 

{hdx_python_utilities-3.6.1 → hdx_python_utilities-3.6.2}/documentation/pydoc-markdown.yaml

@@ -9,7 +9,7 @@ renderer:
   output_directory: docs
   mkdocs_config:
     site_name: HDX Python Utilities
-    theme: readthedocs
+    theme: mkdocs
     repo_url: "https://github.com/OCHA-DAP/hdx-python-utilities"
   markdown:
     source_linker:

{hdx_python_utilities-3.6.1 → hdx_python_utilities-3.6.2}/requirements.txt

@@ -4,6 +4,8 @@
 #
 #    pip-compile --all-extras --output-file=requirements.txt --resolver=backtracking pyproject.toml
 #
+annotated-types==0.5.0
+    # via pydantic
 attrs==23.1.0
     # via
     #   frictionless
@@ -11,15 +13,15 @@ attrs==23.1.0
     #   jsonschema
 beautifulsoup4==4.12.2
     # via hdx-python-utilities (pyproject.toml)
-certifi==2023.5.7
+certifi==2023.7.22
     # via requests
 cfgv==3.3.1
     # via pre-commit
-chardet==5.1.0
+chardet==5.2.0
     # via frictionless
-charset-normalizer==3.1.0
+charset-normalizer==3.2.0
     # via requests
-click==8.1.3
+click==8.1.6
     # via typer
 colorama==0.4.6
     # via typer
@@ -27,9 +29,9 @@ coverage[toml]==7.2.7
     # via pytest-cov
 decorator==5.1.1
     # via validators
-distlib==0.3.6
+distlib==0.3.7
     # via virtualenv
-dnspython==2.3.0
+dnspython==2.4.1
     # via email-validator
 email-validator==2.0.0.post2
     # via hdx-python-utilities (pyproject.toml)
@@ -37,19 +39,19 @@ et-xmlfile==1.1.0
     # via openpyxl
 filelock==3.12.2
     # via virtualenv
-frictionless==5.13.1
+frictionless==5.15.10
     # via hdx-python-utilities (pyproject.toml)
 html5lib==1.1
     # via hdx-python-utilities (pyproject.toml)
-humanize==4.6.0
+humanize==4.7.0
     # via frictionless
-identify==2.5.24
+identify==2.5.26
     # via pre-commit
 idna==3.4
     # via
     #   email-validator
     #   requests
-ijson==3.2.2
+ijson==3.2.3
     # via hdx-python-utilities (pyproject.toml)
 iniconfig==2.0.0
     # via pytest
@@ -83,19 +85,21 @@ packaging==23.1
     # via pytest
 petl==1.7.12
     # via frictionless
-platformdirs==3.7.0
+platformdirs==3.10.0
     # via virtualenv
 pluggy==1.2.0
     # via pytest
 pre-commit==3.3.3
     # via hdx-python-utilities (pyproject.toml)
-pydantic==1.10.9
+pydantic==2.1.1
     # via frictionless
-pygments==2.15.1
+pydantic-core==2.4.0
+    # via pydantic
+pygments==2.16.1
     # via rich
 pyrsistent==0.19.3
     # via jsonschema
-pytest==7.3.2
+pytest==7.4.0
     # via
     #   hdx-python-utilities (pyproject.toml)
     #   pytest-cov
@@ -110,7 +114,7 @@ python-dateutil==2.8.2
     #   hdx-python-utilities (pyproject.toml)
 python-slugify==8.0.1
     # via frictionless
-pyyaml==6.0
+pyyaml==6.0.1
     # via
     #   frictionless
     #   pre-commit
@@ -125,7 +129,7 @@ requests-file==1.5.1
     # via hdx-python-utilities (pyproject.toml)
 rfc3986==2.0.0
     # via frictionless
-rich==13.4.2
+rich==13.5.2
     # via typer
 ruamel-yaml==0.17.32
     # via hdx-python-utilities (pyproject.toml)
@@ -153,16 +157,17 @@ text-unidecode==1.3
     # via python-slugify
 typer[all]==0.9.0
     # via frictionless
-typing-extensions==4.6.3
+typing-extensions==4.7.1
     # via
     #   frictionless
     #   pydantic
+    #   pydantic-core
     #   typer
-urllib3==2.0.3
+urllib3==2.0.4
     # via requests
 validators==0.20.0
     # via frictionless
-virtualenv==20.23.1
+virtualenv==20.24.2
     # via pre-commit
 webencodings==0.5.1
     # via html5lib

{hdx_python_utilities-3.6.1 → hdx_python_utilities-3.6.2}/src/hdx/utilities/_version.py

@@ -1,4 +1,4 @@
 # file generated by setuptools_scm
 # don't change, don't track in version control
-__version__ = version = '3.6.1'
-__version_tuple__ = version_tuple = (3, 6, 1)
+__version__ = version = '3.6.2'
+__version_tuple__ = version_tuple = (3, 6, 2)

{hdx_python_utilities-3.6.1 → hdx_python_utilities-3.6.2}/src/hdx/utilities/email.py

@@ -171,7 +171,7 @@ class Email:
                 recipient, check_deliverability=True
             )  # validate and get info
             normalised_recipients.append(
-                v["email"]
+                v.normalized
             )  # replace with normalized form
         return normalised_recipients
 
@@ -209,7 +209,7 @@ class Email:
         v = validate_email(
             sender, check_deliverability=False
         )  # validate and get info
-        sender = v["email"]  # replace with normalized form
+        sender = v.normalized
 
         if html_body is not None:
             msg = MIMEMultipart("alternative")

{hdx_python_utilities-3.6.1 → hdx_python_utilities-3.6.2}/src/hdx/utilities/state.py

@@ -1,7 +1,8 @@
 """Utility to save state to a file and read it back."""
 import logging
-from typing import Any, Callable
+from typing import Any, Callable, Dict
 
+from hdx.utilities.dateparse import iso_string_from_datetime, parse_date
 from hdx.utilities.loader import load_text
 from hdx.utilities.saver import save_text
 
@@ -91,3 +92,41 @@ class State:
             None
         """
         self.state = state
+
+    @staticmethod
+    def dates_str_to_country_date_dict(dates_str: str) -> Dict:
+        """Convert a comma separated string of key=date string pairs eg.
+        "default=2017-01-01,afg=2019-01-01" to a dictionary of key date
+        mappings eg.
+        {"default": 2017-01-01 as datetime, "afg": 2019-01-01 as datetime}
+
+        Args:
+            dates_str (str): Comma separated string of key=date string pairs
+
+        Returns:
+            Dict: Dictionary of key date mappings
+        """
+        result = {}
+        for keyvalue in dates_str.split(","):
+            key, value = keyvalue.split("=")
+            result[key] = parse_date(value)
+        return result
+
+    @staticmethod
+    def country_date_dict_to_dates_str(country_date_dict: Dict) -> str:
+        """Convert a dictionary of key date mappings eg.
+        {"default": 2017-01-01 as datetime, "afg": 2019-01-01 as datetime}
+        to a comma separated string of key=date string pairs eg.
+        "default=2017-01-01,afg=2019-01-01"
+
+        Args:
+            country_date_dict (Dict): Dictionary of key date mappings
+
+        Returns:
+            str: Comma separated string of key=date string pairs
+        """
+        strlist = []
+        for key, value in country_date_dict.items():
+            valstr = iso_string_from_datetime(value)
+            strlist.append(f"{key}={valstr}")
+        return ",".join(strlist)

hdx_python_utilities-3.6.2/tests/fixtures/state/analysis_dates.txt

@@ -0,0 +1 @@
+DEFAULT=2020-09-23

{hdx_python_utilities-3.6.1 → hdx_python_utilities-3.6.2}/tests/hdx/utilities/test_downloader.py

@@ -55,11 +55,11 @@ class TestDownloader:
 
     @pytest.fixture(scope="class")
     def getfixtureurl(self):
-        return "http://httpbin.org/get"
+        return "https://httpbin.org/get"
 
     @pytest.fixture(scope="class")
     def postfixtureurl(self):
-        return "http://httpbin.org/post"
+        return "https://httpbin.org/post"
 
     @pytest.fixture(scope="class")
     def fixturenotexistsurl(self):

hdx_python_utilities-3.6.2/tests/hdx/utilities/test_state.py

@@ -0,0 +1,83 @@
+"""State Utility Tests"""
+from datetime import datetime, timezone
+from os.path import join
+from shutil import copyfile
+
+import pytest
+
+from hdx.utilities.dateparse import iso_string_from_datetime, parse_date
+from hdx.utilities.path import temp_dir
+from hdx.utilities.state import State
+
+
+class TestState:
+    @pytest.fixture(scope="class")
+    def statefolder(self, fixturesfolder):
+        return join(fixturesfolder, "state")
+
+    @pytest.fixture(scope="class")
+    def statefile(self):
+        return "last_build_date.txt"
+
+    @pytest.fixture(scope="class")
+    def multidatestatefile(self):
+        return "analysis_dates.txt"
+
+    @pytest.fixture(scope="class")
+    def date1(self):
+        return datetime(2020, 9, 23, 0, 0, tzinfo=timezone.utc)
+
+    @pytest.fixture(scope="class")
+    def date2(self):
+        return datetime(2022, 5, 12, 10, 15, tzinfo=timezone.utc)
+
+    def test_state(self, statefolder, statefile, date1, date2):
+        with temp_dir(folder="test_state") as tmpdir:
+            statepath = join(tmpdir, statefile)
+            copyfile(join(statefolder, statefile), statepath)
+            with State(
+                statepath, parse_date, iso_string_from_datetime
+            ) as state:
+                assert state.get() == date1
+            with State(
+                statepath, parse_date, iso_string_from_datetime
+            ) as state:
+                assert state.get() == date1
+                state.set(date2)
+            with State(
+                statepath, parse_date, iso_string_from_datetime
+            ) as state:
+                assert state.get() == date2.replace(hour=0, minute=0)
+
+    def test_multi_date_state(
+        self, statefolder, multidatestatefile, date1, date2
+    ):
+        with temp_dir(folder="test_multidatestate") as tmpdir:
+            statepath = join(tmpdir, multidatestatefile)
+            copyfile(join(statefolder, multidatestatefile), statepath)
+            with State(
+                statepath,
+                State.dates_str_to_country_date_dict,
+                State.country_date_dict_to_dates_str,
+            ) as state:
+                state_dict = state.get()
+                assert state_dict == {"DEFAULT": date1}
+            with State(
+                statepath,
+                State.dates_str_to_country_date_dict,
+                State.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 State(
+                statepath,
+                State.dates_str_to_country_date_dict,
+                State.country_date_dict_to_dates_str,
+            ) as state:
+                state_dict = state.get()
+                assert state_dict == {
+                    "DEFAULT": date1,
+                    "AFG": date2.replace(hour=0, minute=0),
+                }

hdx_python_utilities-3.6.1/tests/hdx/utilities/test_state.py

@@ -1,40 +0,0 @@
-"""State Utility Tests"""
-from datetime import datetime, timezone
-from os.path import join
-from shutil import copyfile
-
-import pytest
-
-from hdx.utilities.dateparse import iso_string_from_datetime, parse_date
-from hdx.utilities.path import temp_dir
-from hdx.utilities.state import State
-
-
-class TestState:
-    @pytest.fixture(scope="class")
-    def statefolder(self, fixturesfolder):
-        return join(fixturesfolder, "state")
-
-    @pytest.fixture(scope="class")
-    def statefile(self):
-        return "last_build_date.txt"
-
-    def test_state(self, statefolder, statefile):
-        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 State(
-                statepath, parse_date, iso_string_from_datetime
-            ) as state:
-                assert state.get() == date1
-            with State(
-                statepath, parse_date, iso_string_from_datetime
-            ) as state:
-                assert state.get() == date1
-                state.set(date2)
-            with State(
-                statepath, parse_date, iso_string_from_datetime
-            ) as state:
-                assert state.get() == date2.replace(hour=0, minute=0)