PEP 257 fixes

Author: oschwald

geoip2/database.py

@@ -41,7 +41,7 @@ class Reader(object):
 """
 
     def __init__(self, filename, locales=None, mode=MODE_AUTO):
-        """Create GeoIP2 Reader
+        """Create GeoIP2 Reader.
 
         :param filename: The path to the GeoIP2 database.
         :param locales: This is list of locale codes. This argument will be
@@ -89,7 +89,7 @@ def __exit__(self, exc_type, exc_value, traceback):
         self.close()
 
     def country(self, ip_address):
-        """Get the Country object for the IP address
+        """Get the Country object for the IP address.
 
         :param ip_address: IPv4 or IPv6 address as a string.
 
@@ -100,7 +100,7 @@ def country(self, ip_address):
         return self._model_for(geoip2.models.Country, 'Country', ip_address)
 
     def city(self, ip_address):
-        """Get the City object for the IP address
+        """Get the City object for the IP address.
 
         :param ip_address: IPv4 or IPv6 address as a string.
 
@@ -110,7 +110,7 @@ def city(self, ip_address):
         return self._model_for(geoip2.models.City, 'City', ip_address)
 
     def anonymous_ip(self, ip_address):
-        """Get the AnonymousIP object for the IP address
+        """Get the AnonymousIP object for the IP address.
 
         :param ip_address: IPv4 or IPv6 address as a string.
 
@@ -121,7 +121,7 @@ def anonymous_ip(self, ip_address):
                                     'GeoIP2-Anonymous-IP', ip_address)
 
     def connection_type(self, ip_address):
-        """Get the ConnectionType object for the IP address
+        """Get the ConnectionType object for the IP address.
 
         :param ip_address: IPv4 or IPv6 address as a string.
 
@@ -132,7 +132,7 @@ def connection_type(self, ip_address):
                                     'GeoIP2-Connection-Type', ip_address)
 
     def domain(self, ip_address):
-        """Get the Domain object for the IP address
+        """Get the Domain object for the IP address.
 
         :param ip_address: IPv4 or IPv6 address as a string.
 
@@ -143,7 +143,7 @@ def domain(self, ip_address):
                                     ip_address)
 
     def enterprise(self, ip_address):
-        """Get the Enterprise object for the IP address
+        """Get the Enterprise object for the IP address.
 
         :param ip_address: IPv4 or IPv6 address as a string.
 
@@ -154,7 +154,7 @@ def enterprise(self, ip_address):
                                ip_address)
 
     def isp(self, ip_address):
-        """Get the ISP object for the IP address
+        """Get the ISP object for the IP address.
 
         :param ip_address: IPv4 or IPv6 address as a string.
 
@@ -187,13 +187,13 @@ def _flat_model_for(self, model_class, types, ip_address):
         return model_class(record)
 
     def metadata(self):
-        """The metadata for the open database
+        """The metadata for the open database.
 
         :returns: :py:class:`maxminddb.reader.Metadata` object
         """
         return self._db_reader.metadata()
 
     def close(self):
-        """Closes the GeoIP2 database"""
+        """Closes the GeoIP2 database."""
 
         self._db_reader.close()

geoip2/models.py

@@ -18,7 +18,7 @@
 
 
 class Country(SimpleEquality):
-    """Model for the GeoIP2 Precision: Country and the GeoIP2 Country database
+    """Model for the GeoIP2 Precision: Country and the GeoIP2 Country database.
 
     This class provides the following attributes:
 
@@ -99,7 +99,8 @@ def __repr__(self):
 
 
 class City(Country):
-    """Model for the GeoIP2 Precision: City and the GeoIP2 City database
+    """Model for the GeoIP2 Precision: City and the GeoIP2 City database.
+
     .. attribute:: city
 
       City object for the requested IP address.
@@ -174,7 +175,7 @@ def __init__(self, raw_response, locales=None):
 
 
 class Insights(City):
-    """Model for the GeoIP2 Precision: Insights web service endpoint
+    """Model for the GeoIP2 Precision: Insights web service endpoint.
 
     .. attribute:: city
 
@@ -238,7 +239,7 @@ class Insights(City):
 
 
 class Enterprise(City):
-    """Model for the GeoIP2 Enterprise database
+    """Model for the GeoIP2 Enterprise database.
 
     .. attribute:: city
 
@@ -315,7 +316,7 @@ def __repr__(self):
 
 
 class AnonymousIP(SimpleModel):
-    """Model class for the GeoIP2 Anonymous IP
+    """Model class for the GeoIP2 Anonymous IP.
 
     This class provides the following attribute:
 
@@ -368,7 +369,7 @@ def __init__(self, raw):
 
 
 class ConnectionType(SimpleModel):
-    """Model class for the GeoIP2 Connection-Type
+    """Model class for the GeoIP2 Connection-Type.
 
     This class provides the following attribute:
 
@@ -399,7 +400,7 @@ def __init__(self, raw):
 
 
 class Domain(SimpleModel):
-    """Model class for the GeoIP2 Domain
+    """Model class for the GeoIP2 Domain.
 
     This class provides the following attribute:
 
@@ -424,7 +425,7 @@ def __init__(self, raw):
 
 
 class ISP(SimpleModel):
-    """Model class for the GeoIP2 ISP
+    """Model class for the GeoIP2 ISP.
 
     This class provides the following attribute:
 

geoip2/records.py

@@ -4,14 +4,16 @@
 =======
 
 """
+
 # pylint:disable=R0903
 from abc import ABCMeta
 
 from geoip2.mixins import SimpleEquality
 
 
 class Record(SimpleEquality):
-    """All records are subclasses of the abstract class ``Record``"""
+    """All records are subclasses of the abstract class ``Record``."""
+
     __metaclass__ = ABCMeta
 
     _valid_attributes = set()
@@ -32,7 +34,8 @@ def __repr__(self):
 
 
 class PlaceRecord(Record):
-    """All records with :py:attr:`names` subclass :py:class:`PlaceRecord`"""
+    """All records with :py:attr:`names` subclass :py:class:`PlaceRecord`."""
+
     __metaclass__ = ABCMeta
 
     def __init__(self, locales=None, **kwargs):
@@ -45,15 +48,15 @@ def __init__(self, locales=None, **kwargs):
 
     @property
     def name(self):
-        """Dict with locale codes as keys and localized name as value"""
+        """Dict with locale codes as keys and localized name as value."""
         # pylint:disable=E1101
         return next(
             (self.names.get(x) for x in self._locales
              if x in self.names), None)
 
 
 class City(PlaceRecord):
-    """Contains data for the city record associated with an IP address
+    """Contains data for the city record associated with an IP address.
 
     This class contains the city-level data associated with an IP address.
 
@@ -90,11 +93,12 @@ class City(PlaceRecord):
       :type: dict
 
     """
+
     _valid_attributes = set(['confidence', 'geoname_id', 'names'])
 
 
 class Continent(PlaceRecord):
-    """Contains data for the continent record associated with an IP address
+    """Contains data for the continent record associated with an IP address.
 
     This class contains the continent-level data associated with an IP
     address.
@@ -130,11 +134,12 @@ class Continent(PlaceRecord):
       :type: dict
 
     """
+
     _valid_attributes = set(['code', 'geoname_id', 'names'])
 
 
 class Country(PlaceRecord):
-    """Contains data for the country record associated with an IP address
+    """Contains data for the country record associated with an IP address.
 
     This class contains the country-level data associated with an IP address.
 
@@ -178,11 +183,12 @@ class Country(PlaceRecord):
       :type: dict
 
     """
+
     _valid_attributes = set(['confidence', 'geoname_id', 'iso_code', 'names'])
 
 
 class RepresentedCountry(Country):
-    """Contains data for the represented country associated with an IP address
+    """Contains data for the represented country associated with an IP address.
 
     This class contains the country-level data associated with an IP address
     for the IP's represented country. The represented country is the country
@@ -236,12 +242,13 @@ class RepresentedCountry(Country):
       :type: unicode
 
     """
+
     _valid_attributes = set(['confidence', 'geoname_id', 'iso_code', 'names',
                              'type'])
 
 
 class Location(Record):
-    """Contains data for the location record associated with an IP address
+    """Contains data for the location record associated with an IP address.
 
     This class contains the location data associated with an IP address.
 
@@ -304,13 +311,14 @@ class Location(Record):
       :type: unicode
 
     """
+
     _valid_attributes = set(['average_income', 'accuracy_radius', 'latitude',
                              'longitude', 'metro_code', 'population_density',
                              'postal_code', 'postal_confidence', 'time_zone'])
 
 
 class MaxMind(Record):
-    """Contains data related to your MaxMind account
+    """Contains data related to your MaxMind account.
 
     Attributes:
 
@@ -322,11 +330,12 @@ class MaxMind(Record):
       :type: int
 
     """
+
     _valid_attributes = set(['queries_remaining'])
 
 
 class Postal(Record):
-    """Contains data for the postal record associated with an IP address
+    """Contains data for the postal record associated with an IP address.
 
     This class contains the postal data associated with an IP address.
 
@@ -352,11 +361,12 @@ class Postal(Record):
       :type: int
 
     """
+
     _valid_attributes = set(['code', 'confidence'])
 
 
 class Subdivision(PlaceRecord):
-    """Contains data for the subdivisions associated with an IP address
+    """Contains data for the subdivisions associated with an IP address.
 
     This class contains the subdivision data associated with an IP address.
 
@@ -402,11 +412,12 @@ class Subdivision(PlaceRecord):
       :type: dict
 
     """
+
     _valid_attributes = set(['confidence', 'geoname_id', 'iso_code', 'names'])
 
 
 class Subdivisions(tuple):
-    """A tuple-like collection of subdivisions associated with an IP address
+    """A tuple-like collection of subdivisions associated with an IP address.
 
     This class contains the subdivisions of the country associated with the
     IP address from largest to smallest.
@@ -430,10 +441,10 @@ def __init__(self, locales, *subdivisions):  # pylint:disable=W0613
     def most_specific(self):
         """The most specific (smallest) subdivision available.
 
-          If there are no :py:class:`Subdivision` objects for the response,
-          this returns an empty :py:class:`Subdivision`.
+        If there are no :py:class:`Subdivision` objects for the response,
+        this returns an empty :py:class:`Subdivision`.
 
-          :type: :py:class:`Subdivision`
+        :type: :py:class:`Subdivision`
         """
         try:
             return self[-1]
@@ -442,7 +453,7 @@ def most_specific(self):
 
 
 class Traits(Record):
-    """ Contains data for the traits record associated with an IP address
+    """Contains data for the traits record associated with an IP address.
 
     This class contains the traits data associated with an IP address.
 
@@ -534,7 +545,8 @@ class Traits(Record):
       .. deprecated:: 2.2.0
         Due to the increased coverage by mobile carriers, very few
         satellite providers now serve multiple countries. As a result, the
-        output does not provide sufficiently relevant data for us to maintain it.
+        output does not provide sufficiently relevant data for us to maintain
+        it.
 
     .. attribute:: isp
 
@@ -578,7 +590,8 @@ class Traits(Record):
 
       :type: unicode
 
-"""
+    """
+
     _valid_attributes = set(
         ['autonomous_system_number', 'autonomous_system_organization',
          'connection_type', 'domain', 'is_anonymous_proxy',