hdx-python-country 3.7.9__tar.gz → 3.8.1__tar.gz

{hdx_python_country-3.7.9 → hdx_python_country-3.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: hdx-python-country
-Version: 3.7.9
+Version: 3.8.1
 Summary: HDX Python country code and exchange rate (fx) utilities
 Project-URL: Homepage, https://github.com/OCHA-DAP/hdx-python-country
 Author: Michael Rans

{hdx_python_country-3.7.9 → hdx_python_country-3.8.1}/documentation/main.md

@@ -130,6 +130,10 @@ object has been set up with parents). Keys take the form "STRING_TO_REPLACE",
 *admin_fuzzy_dont* is a list of names for which fuzzy matching should not be
 tried
 
+A Retrieve object can be passed in the *retriever* parameter that enables
+saving data downloaded to a file or loading previously saved data depending
+on how the Retrieve object is configured.
+
 Once an AdminLevel object is constructed, one of three setup methods must be
 called: *setup_from_admin_info*, *setup_from_libhxl_dataset* or
 *setup_from_url*.

{hdx_python_country-3.7.9 → hdx_python_country-3.8.1}/requirements.txt

@@ -30,7 +30,7 @@ frictionless==5.18.0
     # via hdx-python-utilities
 hdx-python-utilities==3.7.4
     # via hdx-python-country (pyproject.toml)
-humanize==4.10.0
+humanize==4.11.0
     # via frictionless
 identify==2.6.1
     # via pre-commit
@@ -82,7 +82,7 @@ ply==3.11
     # via
     #   jsonpath-ng
     #   libhxl
-pre-commit==3.8.0
+pre-commit==4.0.0
     # via hdx-python-country (pyproject.toml)
 pydantic==2.9.2
     # via frictionless
@@ -127,7 +127,7 @@ requests-file==2.1.0
     # via hdx-python-utilities
 rfc3986==2.0.0
     # via frictionless
-rich==13.9.1
+rich==13.9.2
     # via typer
 rpds-py==0.20.0
     # via
@@ -139,7 +139,7 @@ ruamel-yaml-clib==0.2.8
     # via ruamel-yaml
 shellingham==1.5.4
     # via typer
-simpleeval==0.9.13
+simpleeval==1.0.0
     # via frictionless
 six==1.16.0
     # via

{hdx_python_country-3.7.9 → hdx_python_country-3.8.1}/src/hdx/location/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '3.7.9'
-__version_tuple__ = version_tuple = (3, 7, 9)
+__version__ = version = '3.8.1'
+__version_tuple__ = version_tuple = (3, 8, 1)

{hdx_python_country-3.7.9 → hdx_python_country-3.8.1}/src/hdx/location/adminlevel.py

@@ -50,9 +50,10 @@ class AdminLevel:
 
     pcode_regex = re.compile(r"^([a-zA-Z]{2,3})(\d+)$")
     _admin_url_default = "https://data.humdata.org/dataset/cb963915-d7d1-4ffa-90dc-31277e24406f/resource/f65bc260-4d8b-416f-ac07-f2433b4d5142/download/global_pcodes_adm_1_2.csv"
-    _admin_url = _admin_url_default
+    admin_url = _admin_url_default
+    admin_all_pcodes_url = "https://data.humdata.org/dataset/cb963915-d7d1-4ffa-90dc-31277e24406f/resource/793e66fe-4cdb-4076-b037-fb8c053239e2/download/global_pcodes.csv"
     _formats_url_default = "https://data.humdata.org/dataset/cb963915-d7d1-4ffa-90dc-31277e24406f/resource/f1161807-dab4-4331-b7b0-4e5dac56e0e4/download/global_pcode_lengths.csv"
-    _formats_url = _formats_url_default
+    formats_url = _formats_url_default
 
     def __init__(
         self,
@@ -113,22 +114,26 @@ class AdminLevel:
         """
         if admin_url is None:
             admin_url = cls._admin_url_default
-        cls._admin_url = admin_url
+        cls.admin_url = admin_url
 
-    def get_libhxl_dataset(self, url: str = _admin_url) -> hxl.Dataset:
+    @staticmethod
+    def get_libhxl_dataset(
+        url: str = admin_url, retriever: Optional[Retrieve] = None
+    ) -> hxl.Dataset:
         """
         Get libhxl Dataset object given a URL which defaults to global p-codes
         dataset on HDX.
 
         Args:
-            admin_url (str): URL from which to load data.
+            url (str): URL from which to load data. Defaults to internal admin url.
+            retriever (Optional[Retrieve]): Retriever object to use for loading file. Defaults to None.
 
         Returns:
-            None
+            hxl.Dataset: HXL Dataset object
         """
-        if self.retriever:
+        if retriever:
             try:
-                url_to_use = self.retriever.download_file(url)
+                url_to_use = retriever.download_file(url)
             except DownloadError:
                 logger.exception(
                     f"Setup of libhxl Dataset object with {url} failed!"
@@ -258,7 +263,7 @@ class AdminLevel:
 
     def setup_from_url(
         self,
-        admin_url: str = _admin_url,
+        admin_url: str = admin_url,
         countryiso3s: Optional[ListTuple[str]] = None,
     ) -> None:
         """
@@ -271,21 +276,22 @@ class AdminLevel:
         Returns:
             None
         """
-        admin_info = self.get_libhxl_dataset(admin_url)
+        admin_info = self.get_libhxl_dataset(admin_url, self.retriever)
         self.setup_from_libhxl_dataset(admin_info, countryiso3s)
 
-    def load_pcode_formats(self, formats_url: str = _formats_url) -> None:
+    def load_pcode_formats_from_libhxl_dataset(
+        self, libhxl_dataset: hxl.Dataset
+    ) -> None:
         """
-        Load p-code formats from a URL. Defaults to global p-codes dataset on HDX.
+        Load p-code formats from a libhxl Dataset object.
 
         Args:
-            formats_url (str): URL from which to load data. Defaults to global p-codes dataset.
+            libhxl_dataset (hxl.Dataset): Dataset object from libhxl library
 
         Returns:
             None
         """
-        formats_info = self.get_libhxl_dataset(formats_url)
-        for row in formats_info:
+        for row in libhxl_dataset:
             pcode_format = [int(row.get("#country+len"))]
             for admin_no in range(1, 4):
                 length = row.get(f"#adm{admin_no}+len")
@@ -299,6 +305,19 @@ class AdminLevel:
             for x in re.finditer("0", pcode):
                 dict_of_sets_add(self.zeroes, countryiso3, x.start())
 
+    def load_pcode_formats(self, formats_url: str = formats_url) -> None:
+        """
+        Load p-code formats from a URL. Defaults to global p-codes dataset on HDX.
+
+        Args:
+            formats_url (str): URL from which to load data. Defaults to global p-codes dataset.
+
+        Returns:
+            None
+        """
+        formats_info = self.get_libhxl_dataset(formats_url, self.retriever)
+        self.load_pcode_formats_from_libhxl_dataset(formats_info)
+
     def set_parent_admins(self, parent_admins: List[List]) -> None:
         """
         Set parent admins

{hdx_python_country-3.7.9 → hdx_python_country-3.8.1}/tests/hdx/location/test_adminlevel.py

@@ -381,9 +381,9 @@ class TestAdminLevel:
             adminone.setup_from_url("fake_url")
         adminone = AdminLevel(config)
         AdminLevel.set_default_admin_url()
-        assert AdminLevel._admin_url == AdminLevel._admin_url_default
+        assert AdminLevel.admin_url == AdminLevel._admin_url_default
         AdminLevel.set_default_admin_url(url)
-        assert AdminLevel._admin_url == url
+        assert AdminLevel.admin_url == url
         adminone.setup_from_url(countryiso3s=("YEM",))
         assert len(adminone.get_pcode_list()) == 22