Merge pull request #214 from Bost/renaming

Renamings

Author: ExpDev07

app/location/__init__.py

@@ -1,5 +1,5 @@
 from ..coordinates import Coordinates
-from ..utils import countrycodes
+from ..utils import countries
 from ..utils.populations import country_population
 
 
@@ -31,7 +31,7 @@ def country_code(self):
         :returns: The country code.
         :rtype: str
         """
-        return (countrycodes.country_code(self.country) or countrycodes.default_code).upper()
+        return (countries.country_code(self.country) or countries.default_country_code).upper()
 
     @property
     def country_population(self):

app/services/location/jhu.py

@@ -7,7 +7,7 @@
 from ...coordinates import Coordinates
 from ...location import TimelinedLocation
 from ...timeline import Timeline
-from ...utils import countrycodes
+from ...utils import countries
 from ...utils import date as date_util
 from . import LocationService
 
@@ -80,7 +80,7 @@ def get_category(category):
             {
                 # General info.
                 "country": country,
-                "country_code": countrycodes.country_code(country),
+                "country_code": countries.country_code(country),
                 "province": item["Province/State"],
                 # Coordinates.
                 "coordinates": {"lat": item["Lat"], "long": item["Long"],},

app/utils/countrycodes.py app/utils/countries.pyapp/utils/countrycodes.py renamed to app/utils/countries.py

@@ -4,13 +4,13 @@
 LOGGER = logging.getLogger(__name__)
 
 # Default country code.
-default_code = "XX"
+default_country_code = "XX"
 
 # Mapping of country names to alpha-2 codes according to
 # https://en.wikipedia.org/wiki/ISO_3166-1.
 # As a reference see also https://github.com/TakahikoKawasaki/nv-i18n (in Java)
 # fmt: off
-is_3166_1 = {
+country_name__country_code = {
     "Afghanistan"                                  : "AF",
     "Åland Islands"                                : "AX",
     "Albania"                                      : "AL",
@@ -269,13 +269,13 @@
     "Iraq-Saudi Arabia Neutral Zone"              : "XE",
     "Spratly Islands"                             : "XS",
 
-    # TODO "Disputed Territory" conflicts with `default_code`
+    # TODO "Disputed Territory" conflicts with `default_country_code`
     # "Disputed Territory"                          : "XX",
 }
 
 # Mapping of alternative names, spelling, typos to the names of countries used
 # by the ISO 3166-1 norm
-synonyms = {
+country_alias__country_name = {
     "Mainland China"                 : "China",
     "Czechia"                        : "Czech Republic",
     "Channel Islands"                : "United Kingdom",
@@ -372,16 +372,15 @@ def country_code(country):
     Return two letter country code (Alpha-2) according to https://en.wikipedia.org/wiki/ISO_3166-1
     Defaults to "XX".
     """
-    # Look in synonyms if not found.
-    if not country in is_3166_1 and country in synonyms:
-        country = synonyms[country]
+    if not country in country_name__country_code and country in country_alias__country_name:
+        country = country_alias__country_name[country]
 
     # Get country or fallback to default_code.
-    country_code = is_3166_1.get(country, default_code)
+    country_code = country_name__country_code.get(country, default_country_code)
 
     # Default picked?
-    if country_code == default_code:
-        LOGGER.warning(f"No country_code found for '{country}'. Using '{country_code}'!")
+    if country_code == default_country_code:
+        LOGGER.warning(f"No country code found for '{country}'. Using '{country_code}'!")
 
     # Return.
     return country_code

app/utils/populations.py

@@ -5,7 +5,7 @@
 import requests
 from cachetools import TTLCache, cached
 
-from .countrycodes import country_code
+from .countries import country_code
 
 LOGGER = logging.getLogger(__name__)
 

tests/test_countrycodes.py tests/test_countries.pytests/test_countrycodes.py renamed to tests/test_countries.py

@@ -1,6 +1,6 @@
 import pytest
 
-from app.utils import countrycodes
+from app.utils import countries
 
 
 """
@@ -18,13 +18,13 @@
         ("BlaBla", "XX"),
     ],
 )
-def test_countrycodes_is_3166_1(country_name, expected_country_code):
-    assert countrycodes.country_code(country_name) == expected_country_code
+def test_countries_country_name__country_code(country_name, expected_country_code):
+    assert countries.country_code(country_name) == expected_country_code
 
 
 @pytest.mark.parametrize(
-    "country_name_synonym, expected_country_code",
+    "country_name_alias, expected_country_code",
     [("Deutschland", "DE"), ("Iran (Islamic Republic of)", "IR"), ("British Virgin Islands", "VG")],
 )
-def test_countrycodes_synonym(country_name_synonym, expected_country_code):
-    assert countrycodes.country_code(country_name_synonym) == expected_country_code
+def test_country_name_alias(country_name_alias, expected_country_code):
+    assert countries.country_code(country_name_alias) == expected_country_code