Renamed languages to locales in code

Author: oschwald

geoip2/database.py

@@ -40,11 +40,11 @@ class Reader(object):
 
 """
 
-    def __init__(self, filename, languages=None):
-        if languages is None:
-            languages = ['en']
+    def __init__(self, filename, locales=None):
+        if locales is None:
+            locales = ['en']
         self.db_reader = maxminddb.Reader(filename)
-        self.languages = languages
+        self.locales = locales
 
     def country(self, ip_address):
         """Get the Country record object for the IP address
@@ -102,7 +102,7 @@ def _model_for(self, model_class, ip_address):
             raise geoip2.errors.AddressNotFoundError(
                 "The address %s is not in the database." % (ip_address))
         record.setdefault('traits', {})['ip_address'] = ip_address
-        return model_class(record, languages=self.languages)
+        return model_class(record, locales=self.locales)
 
     def close(self):
         """Closes the GeoIP2 database"""

geoip2/models.py

@@ -65,21 +65,21 @@ class Country(object):
 
     """
 
-    def __init__(self, raw_response, languages=None):
-        if languages is None:
-            languages = ['en']
+    def __init__(self, raw_response, locales=None):
+        if locales is None:
+            locales = ['en']
         self.continent = \
-            geoip2.records.Continent(languages,
+            geoip2.records.Continent(locales,
                                      **raw_response.get('continent', {}))
         self.country = \
-            geoip2.records.Country(languages,
+            geoip2.records.Country(locales,
                                    **raw_response.get('country', {}))
         self.registered_country = \
-            geoip2.records.Country(languages,
+            geoip2.records.Country(locales,
                                    **raw_response.get('registered_country',
                                                       {}))
         self.represented_country \
-            = geoip2.records.RepresentedCountry(languages,
+            = geoip2.records.RepresentedCountry(locales,
                                                 **raw_response.get(
                                                 'represented_country', {}))
 
@@ -155,16 +155,16 @@ class City(Country):
 
 """
 
-    def __init__(self, raw_response, languages=None):
-        super(City, self).__init__(raw_response, languages)
+    def __init__(self, raw_response, locales=None):
+        super(City, self).__init__(raw_response, locales)
         self.city = \
-            geoip2.records.City(languages, **raw_response.get('city', {}))
+            geoip2.records.City(locales, **raw_response.get('city', {}))
         self.location = \
             geoip2.records.Location(**raw_response.get('location', {}))
         self.postal = \
             geoip2.records.Postal(**raw_response.get('postal', {}))
         self.subdivisions = \
-            geoip2.records.Subdivisions(languages,
+            geoip2.records.Subdivisions(locales,
                                         *raw_response.get('subdivisions', []))
 
 

geoip2/records.py

@@ -28,19 +28,19 @@ class PlaceRecord(Record):
     """All records with :py:attr:`names` subclass :py:class:`PlaceRecord`"""
     __metaclass__ = ABCMeta
 
-    def __init__(self, languages=None, **kwargs):
-        if languages is None:
-            languages = ['en']
+    def __init__(self, locales=None, **kwargs):
+        if locales is None:
+            locales = ['en']
         if kwargs.get('names') is None:
             kwargs['names'] = {}
-        object.__setattr__(self, '_languages', languages)
+        object.__setattr__(self, '_locales', locales)
         super(PlaceRecord, self).__init__(**kwargs)
 
     @property
     def name(self):
         """Dict with locale codes as keys and localized name as value"""
         # pylint:disable=E1101
-        return next((self.names.get(x) for x in self._languages if x in
+        return next((self.names.get(x) for x in self._locales if x in
                      self.names), None)
 
 
@@ -71,8 +71,8 @@ class City(PlaceRecord):
 
     .. attribute:: name
 
-      The name of the city based on the languages list
-      passed to the constructor. This attribute is returned by all end points.
+      The name of the city based on the locales list passed to the
+      constructor. This attribute is returned by all end points.
 
       :type: unicode
 
@@ -115,8 +115,8 @@ class Continent(PlaceRecord):
 
     .. attribute:: name
 
-      Returns the name of the continent based on the languages list
-      passed to the constructor. This attribute is returned by all end points.
+      Returns the name of the continent based on the locales list passed to
+      the constructor. This attribute is returned by all end points.
 
       :type: unicode
 
@@ -167,8 +167,8 @@ class Country(PlaceRecord):
 
     .. attribute:: name
 
-      The name of the country based on the languages list
-      passed to the constructor. This attribute is returned by all end points.
+      The name of the country based on the locales list passed to the
+      constructor. This attribute is returned by all end points.
 
       :type: unicode
 
@@ -221,8 +221,8 @@ class RepresentedCountry(Country):
 
     .. attribute:: name
 
-      The name of the country based on the languages list
-      passed to the constructor. This attribute is returned by all end points.
+      The name of the country based on the locales list passed to the
+      constructor. This attribute is returned by all end points.
 
       :type: unicode
 
@@ -395,8 +395,8 @@ class Subdivision(PlaceRecord):
 
     .. attribute:: name
 
-      The name of the subdivision based on the languages list
-      passed to the constructor. This attribute is returned by all end points.
+      The name of the subdivision based on the locales list passed to the
+      constructor. This attribute is returned by all end points.
 
       :type: unicode
 
@@ -427,10 +427,10 @@ class Subdivisions(tuple):
 
     """
     # pylint:disable=R0924,W0212,W0142
-    def __new__(cls, languages, *subdivisions):
-        subdivisions = [Subdivision(languages, **x) for x in subdivisions]
+    def __new__(cls, locales, *subdivisions):
+        subdivisions = [Subdivision(locales, **x) for x in subdivisions]
         obj = super(cls, Subdivisions).__new__(cls, subdivisions)
-        obj._languages = languages
+        obj._locales = locales
         return obj
 
     @property
@@ -445,7 +445,7 @@ def most_specific(self):
         try:
             return self[-1]
         except IndexError:
-            return Subdivision(self._languages)
+            return Subdivision(self._locales)
 
 
 class Traits(Record):

geoip2/webservice.py

@@ -59,16 +59,16 @@ class Client(object):
     :param host: The hostname to make a request against. This defaults to
       "geoip.maxmind.com". In most cases, you should not need to set this
       explicitly.
-    :param languages: This is list of locale codes. This argument will be
+    :param locales: This is list of locale codes. This argument will be
       passed on to record classes to use when their name properties are
       called. The default value is ['en'].
 
-      The order of the languages is significant. When a record class has
+      The order of the locales is significant. When a record class has
       multiple names (country, city, etc.), its name property will return
-      the name in the first language that has one.
+      the name in the first locale that has one.
 
-      Note that the only language which is always present in the GeoIP2
-      data is "en". If you do not include this language, the name property
+      Note that the only locale which is always present in the GeoIP2
+      data is "en". If you do not include this locale, the name property
       may end up returning None even when the record has an English name.
 
       Currently, the valid locale codes are:
@@ -87,10 +87,10 @@ class Client(object):
     """
 
     def __init__(self, user_id, license_key, host='geoip.maxmind.com',
-                 languages=None):
-        if languages is None:
-            languages = ['en']
-        self.languages = languages
+                 locales=None):
+        if locales is None:
+            locales = ['en']
+        self.locales = locales
         self.user_id = user_id
         self.license_key = license_key
         self._base_uri = 'https://%s/geoip/v2.0' % (host)
@@ -154,7 +154,7 @@ def _response_for(self, path, model_class, ip_address):
                                          'User-Agent': self._user_agent()})
         if (response.status_code == 200):  # pylint:disable=E1103
             body = self._handle_success(response, uri)
-            return model_class(body, languages=self.languages)
+            return model_class(body, locales=self.locales)
         else:
             self._handle_error(response, uri)
 

tests/database_test.py

@@ -20,7 +20,7 @@
 
 class TestReader(unittest.TestCase):
 
-    def test_default_language(self):
+    def test_default_locale(self):
         reader = geoip2.database.Reader(
             'tests/data/test-data/GeoIP2-City-Test.mmdb')
         record = reader.city('81.2.69.160')