hdx-python-country 3.8.3__tar.gz → 3.8.5__tar.gz

{hdx_python_country-3.8.3 → hdx_python_country-3.8.5}/PKG-INFO

@@ -1,11 +1,10 @@
 Metadata-Version: 2.3
 Name: hdx-python-country
-Version: 3.8.3
+Version: 3.8.5
 Summary: HDX Python country code and exchange rate (fx) utilities
 Project-URL: Homepage, https://github.com/OCHA-DAP/hdx-python-country
 Author: Michael Rans
 License: MIT
-License-File: LICENSE
 Keywords: HDX,country,country code,currencies,currency,exchange rate,foreign exchange,fx,iso 3166,iso2,iso3,location,region
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers

{hdx_python_country-3.8.3 → hdx_python_country-3.8.5}/requirements.txt

@@ -18,7 +18,7 @@ charset-normalizer==3.4.0
     # via requests
 click==8.1.7
     # via typer
-coverage==7.6.4
+coverage==7.6.7
     # via pytest-cov
 distlib==0.3.9
     # via virtualenv
@@ -32,7 +32,7 @@ hdx-python-utilities==3.7.4
     # via hdx-python-country (pyproject.toml)
 humanize==4.11.0
     # via frictionless
-identify==2.6.1
+identify==2.6.2
     # via pre-commit
 idna==3.10
     # via requests
@@ -70,12 +70,10 @@ nodeenv==1.9.1
     # via pre-commit
 openpyxl==3.1.5
     # via hdx-python-utilities
-packaging==24.1
+packaging==24.2
     # via pytest
 petl==1.7.15
     # via frictionless
-pip==24.3.1
-    # via simpleeval
 platformdirs==4.3.6
     # via virtualenv
 pluggy==1.5.0
@@ -129,9 +127,9 @@ requests-file==2.1.0
     # via hdx-python-utilities
 rfc3986==2.0.0
     # via frictionless
-rich==13.9.3
+rich==13.9.4
     # via typer
-rpds-py==0.20.0
+rpds-py==0.21.0
     # via
     #   jsonschema
     #   referencing
@@ -141,7 +139,7 @@ ruamel-yaml-clib==0.2.12
     # via ruamel-yaml
 shellingham==1.5.4
     # via typer
-simpleeval==1.0.1
+simpleeval==1.0.3
     # via frictionless
 six==1.16.0
     # via python-dateutil
@@ -157,7 +155,7 @@ tenacity==9.0.0
     # via hdx-python-country (pyproject.toml)
 text-unidecode==1.3
     # via python-slugify
-typer==0.12.5
+typer==0.13.1
     # via frictionless
 typing-extensions==4.12.2
     # via
@@ -177,13 +175,13 @@ validators==0.34.0
     # via frictionless
 virtualenv==20.27.1
     # via pre-commit
-wheel==0.44.0
+wheel==0.45.0
     # via libhxl
 xlrd==2.0.1
     # via hdx-python-utilities
 xlrd3==1.1.0
     # via libhxl
-xlsx2csv==0.8.3
+xlsx2csv==0.8.4
     # via hdx-python-utilities
 xlsxwriter==3.2.0
     # via tableschema-to-template

{hdx_python_country-3.8.3 → hdx_python_country-3.8.5}/src/hdx/location/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '3.8.3'
-__version_tuple__ = version_tuple = (3, 8, 3)
+__version__ = version = '3.8.5'
+__version_tuple__ = version_tuple = (3, 8, 5)

{hdx_python_country-3.8.3 → hdx_python_country-3.8.5}/src/hdx/location/country.py

@@ -2,6 +2,7 @@
 
 import copy
 import logging
+import os.path
 import re
 from string import punctuation
 from typing import Dict, List, Optional, Tuple, Union
@@ -73,6 +74,11 @@ class Country:
     _countriesdata = None
     _ochaurl_default = "https://docs.google.com/spreadsheets/d/1NjSI2LaS3SqbgYc0HdD8oIb7lofGtiHgoKKATCpwVdY/export?format=csv&gid=1088874596"
     _ochaurl = _ochaurl_default
+    _ochapath_default = script_dir_plus_file(
+        "Countries & Territories Taxonomy MVP - C&T Taxonomy with HXL Tags.csv",
+        CountryError,
+    )
+    _ochapath = _ochapath_default
     _country_name_overrides = {}
     _country_name_mappings = {}
 
@@ -206,7 +212,7 @@ class Country:
     @classmethod
     def countriesdata(
         cls,
-        use_live: bool = _use_live,
+        use_live: bool = None,
         country_name_overrides: Dict = None,
         country_name_mappings: Dict = None,
     ) -> List[Dict[str, Dict]]:
@@ -221,6 +227,8 @@ class Country:
         Returns:
             List[Dict[str,Dict]]: Countries dictionaries
         """
+        if use_live is None:
+            use_live = cls._use_live
         if cls._countriesdata is None:
             countries = None
             if country_name_overrides is not None:
@@ -238,10 +246,7 @@ class Country:
                     )
             if countries is None:
                 countries = hxl.data(
-                    script_dir_plus_file(
-                        "Countries & Territories Taxonomy MVP - C&T Taxonomy with HXL Tags.csv",
-                        Country,
-                    ),
+                    cls._ochapath,
                     InputOptions(allow_local=True, encoding="utf-8"),
                 )
             cls.set_countriesdata(countries)
@@ -264,7 +269,7 @@ class Country:
         cls._use_live = use_live
 
     @classmethod
-    def set_ocha_url(cls, url: Optional[str] = None) -> None:
+    def set_ocha_url(cls, url: str = None) -> None:
         """
         Set OCHA url from which to retrieve countries data
 
@@ -278,6 +283,21 @@ class Country:
             url = cls._ochaurl_default
         cls._ochaurl = url
 
+    @classmethod
+    def set_ocha_path(cls, path: Optional[str] = None) -> None:
+        """
+        Set local path from which to retrieve OCHA countries data
+
+        Args:
+            path (Optional[str]): Local path from which to retrieve countries data. Defaults to None.
+
+        Returns:
+            None
+        """
+        if not path or (path and not os.path.exists(path)):
+            path = cls._ochapath_default
+        cls._ochapath = path
+
     @classmethod
     def set_country_name_overrides(cls, country_name_overrides: Dict) -> None:
         """
@@ -308,7 +328,7 @@ class Country:
     def get_country_info_from_iso3(
         cls,
         iso3: str,
-        use_live: bool = _use_live,
+        use_live: bool = None,
         exception: Optional[ExceptionUpperBound] = None,
     ) -> Optional[Dict[str, str]]:
         """Get country information from ISO3 code
@@ -334,7 +354,7 @@ class Country:
     def get_country_name_from_iso3(
         cls,
         iso3: str,
-        use_live: bool = _use_live,
+        use_live: bool = None,
         exception: Optional[ExceptionUpperBound] = None,
         formal: bool = False,
     ) -> Optional[str]:
@@ -371,7 +391,7 @@ class Country:
     def get_currency_from_iso3(
         cls,
         iso3: str,
-        use_live: bool = _use_live,
+        use_live: bool = None,
         exception: Optional[ExceptionUpperBound] = None,
     ) -> Optional[int]:
         """Get currency code from ISO3 code
@@ -397,7 +417,7 @@ class Country:
     def get_iso2_from_iso3(
         cls,
         iso3: str,
-        use_live: bool = _use_live,
+        use_live: bool = None,
         exception: Optional[ExceptionUpperBound] = None,
     ) -> Optional[str]:
         """Get ISO2 from ISO3 code
@@ -423,7 +443,7 @@ class Country:
     def get_iso3_from_iso2(
         cls,
         iso2: str,
-        use_live: bool = _use_live,
+        use_live: bool = None,
         exception: Optional[ExceptionUpperBound] = None,
     ) -> Optional[str]:
         """Get ISO3 from ISO2 code
@@ -449,7 +469,7 @@ class Country:
     def get_country_info_from_iso2(
         cls,
         iso2: str,
-        use_live: bool = _use_live,
+        use_live: bool = None,
         exception: Optional[ExceptionUpperBound] = None,
     ) -> Optional[Dict[str, str]]:
         """Get country name from ISO2 code
@@ -475,7 +495,7 @@ class Country:
     def get_country_name_from_iso2(
         cls,
         iso2: str,
-        use_live: bool = _use_live,
+        use_live: bool = None,
         exception: Optional[ExceptionUpperBound] = None,
         formal: bool = False,
     ) -> Optional[str]:
@@ -503,7 +523,7 @@ class Country:
     def get_currency_from_iso2(
         cls,
         iso2: str,
-        use_live: bool = _use_live,
+        use_live: bool = None,
         exception: Optional[ExceptionUpperBound] = None,
     ) -> Optional[str]:
         """Get currency from ISO2 code
@@ -529,7 +549,7 @@ class Country:
     def get_m49_from_iso3(
         cls,
         iso3: str,
-        use_live: bool = _use_live,
+        use_live: bool = None,
         exception: Optional[ExceptionUpperBound] = None,
     ) -> Optional[int]:
         """Get M49 from ISO3 code
@@ -555,7 +575,7 @@ class Country:
     def get_iso3_from_m49(
         cls,
         m49: int,
-        use_live: bool = _use_live,
+        use_live: bool = None,
         exception: Optional[ExceptionUpperBound] = None,
     ) -> Optional[str]:
         """Get ISO3 from M49 code
@@ -581,7 +601,7 @@ class Country:
     def get_country_info_from_m49(
         cls,
         m49: int,
-        use_live: bool = _use_live,
+        use_live: bool = None,
         exception: Optional[ExceptionUpperBound] = None,
     ) -> Optional[Dict[str, str]]:
         """Get country name from M49 code
@@ -605,7 +625,7 @@ class Country:
     def get_country_name_from_m49(
         cls,
         m49: int,
-        use_live: bool = _use_live,
+        use_live: bool = None,
         exception: Optional[ExceptionUpperBound] = None,
         formal: bool = False,
     ) -> Optional[str]:
@@ -633,7 +653,7 @@ class Country:
     def get_currency_from_m49(
         cls,
         m49: int,
-        use_live: bool = _use_live,
+        use_live: bool = None,
         exception: Optional[ExceptionUpperBound] = None,
     ) -> Optional[str]:
         """Get currency from M49 code
@@ -736,7 +756,7 @@ class Country:
     def get_iso3_country_code(
         cls,
         country: str,
-        use_live: bool = _use_live,
+        use_live: bool = None,
         exception: Optional[ExceptionUpperBound] = None,
     ) -> Optional[str]:
         """Get ISO3 code for cls. Only exact matches or None are returned.
@@ -796,7 +816,7 @@ class Country:
     def get_iso3_country_code_fuzzy(
         cls,
         country: str,
-        use_live: bool = _use_live,
+        use_live: bool = None,
         exception: Optional[ExceptionUpperBound] = None,
         min_chars: int = 5,
     ) -> Tuple[Optional[str], bool]:
@@ -886,7 +906,7 @@ class Country:
     def get_countries_in_region(
         cls,
         region: Union[int, str],
-        use_live: bool = _use_live,
+        use_live: bool = None,
         exception: Optional[ExceptionUpperBound] = None,
     ) -> List[str]:
         """Get countries (ISO3 codes) in region

{hdx_python_country-3.8.3 → hdx_python_country-3.8.5}/tests/hdx/location/test_country.py

@@ -12,8 +12,19 @@ class LocationError(Exception):
     pass
 
 
-# Note that the Country class is set up in __init__.py
 class TestCountry:
+    @pytest.fixture(scope="function", autouse=True)
+    def setup(self):
+        # Clean up Country class before each test
+        Country._countriesdata = None
+        Country.set_use_live_default(False)
+        Country.set_ocha_url()
+        Country.set_ocha_path()
+        Country.countriesdata(
+            country_name_overrides={"PSE": "oPt"},
+            country_name_mappings={"Congo DR": "COD"},
+        )
+
     def test_get_country_name_from_iso3(self):
         assert Country.get_country_name_from_iso3("jpn") == "Japan"
         assert Country.get_country_name_from_iso3("awe") is None
@@ -696,8 +707,17 @@ class TestCountry:
         assert Country._use_live is True
         Country.set_use_live_default(False)
         assert Country._use_live is False
+        # We should now be able to load from local data without setting use_live=False
+        Country._countriesdata = None
+        Country.set_ocha_path(
+            script_dir_plus_file("Countries_UZB_Deleted.csv", TestCountry)
+        )
+        assert Country.get_iso3_country_code("UZBEKISTAN") is None
         Country.set_use_live_default(None)
         assert Country._use_live is True
+        Country._countriesdata = None
+        assert Country.get_iso3_country_code("UZBEKISTAN") == "UZB"
+        Country._countriesdata = None
 
     def test_ocha_feed_file_working(self):
         countries = hxl.data(
@@ -716,3 +736,19 @@ class TestCountry:
         Country.set_ocha_url("NOTEXIST")
         Country._countriesdata = None
         assert Country.get_iso3_from_iso2("AF") == "AFG"
+
+    def test_ocha_feed_local_file_working(self):
+        Country._countriesdata = None
+        Country.set_ocha_path(
+            script_dir_plus_file("Countries_UZB_Deleted.csv", TestCountry)
+        )
+        assert (
+            Country.get_iso3_country_code("UZBEKISTAN", use_live=False) is None
+        )
+
+        Country._countriesdata = None
+        Country.set_ocha_path()
+        assert (
+            Country.get_iso3_country_code("UZBEKISTAN", use_live=False)
+            == "UZB"
+        )

hdx_python_country-3.8.3/tests/hdx/location/__init__.py

@@ -1,8 +0,0 @@
-from hdx.location.country import Country
-
-Country.set_use_live_default(False)
-
-Country.countriesdata(
-    country_name_overrides={"PSE": "oPt"},
-    country_name_mappings={"Congo DR": "COD"},
-)