Add misc doc strings

Author: oschwald

examples/benchmark.py

@@ -1,5 +1,5 @@
 #!/usr/bin/python
-
+"""Simple benchmarking script."""
 
 import argparse
 import contextlib
@@ -21,6 +21,7 @@
 
 
 def lookup_ip_address() -> None:
+    """Look up IP address."""
     ip = socket.inet_ntoa(struct.pack("!L", random.getrandbits(32)))
     with contextlib.suppress(geoip2.errors.AddressNotFoundError):
         reader.city(str(ip))

geoip2/__init__.py

@@ -1,3 +1,5 @@
+"""geoip2 client library."""
+
 # pylint:disable=C0111
 
 __title__ = "geoip2"

geoip2/database.py

@@ -306,12 +306,12 @@ def _flat_model_for(
     def metadata(
         self,
     ) -> maxminddb.reader.Metadata:
-        """The metadata for the open database.
+        """Get the metadata for the open database.
 
         :returns: :py:class:`maxminddb.reader.Metadata` object
         """
         return self._db_reader.metadata()
 
     def close(self) -> None:
-        """Closes the GeoIP2 database."""
+        """Close the GeoIP2 database."""
         self._db_reader.close()

geoip2/errors.py

@@ -29,6 +29,15 @@ def __init__(
         ip_address: str | None = None,
         prefix_len: int | None = None,
     ) -> None:
+        """Initialize self.
+
+        Arguments:
+            message: A message describing the error.
+            ip_address: The IP address that was not found.
+            prefix_len: The prefix length for the network associated with
+                        the IP address.
+
+        """
         super().__init__(message)
         self.ip_address = ip_address
         self._prefix_len = prefix_len
@@ -74,6 +83,15 @@ def __init__(
         uri: str | None = None,
         decoded_content: str | None = None,
     ) -> None:
+        """Initialize self.
+
+        Arguments:
+            message: A descriptive message for the error.
+            http_status: The HTTP status code associated with the error, if any.
+            uri: The URI that was being accessed when the error occurred.
+            decoded_content: The decoded HTTP response body, if available.
+
+        """
         super().__init__(message)
         self.http_status = http_status
         self.uri = uri

geoip2/records.py

@@ -345,11 +345,30 @@ class Subdivisions(tuple):
     This attribute is returned by ``city``, ``enterprise``, and ``insights``.
     """
 
+    __slots__ = ("_locales",)
+
     def __new__(
         cls: type[Self],
         locales: Sequence[str] | None,
         *subdivisions: dict,
     ) -> Self:
+        """Create a new Subdivisions instance.
+
+        This method constructs the tuple with Subdivision objects created
+        from the provided dictionaries.
+
+        Arguments:
+            cls: The class to instantiate (Subdivisions).
+            locales: A sequence of locale strings (e.g., ['en', 'fr'])
+                or None, passed to each Subdivision object.
+            *subdivisions: A variable number of dictionaries, where each
+                dictionary contains the data for a single :py:class:`Subdivision`
+                object (e.g., name, iso_code).
+
+        Returns:
+            A new instance of Subdivisions containing :py:class:`Subdivision` objects.
+
+        """
         subobjs = tuple(Subdivision(locales, **x) for x in subdivisions)
         return super().__new__(cls, subobjs)
 
@@ -358,6 +377,7 @@ def __init__(
         locales: Sequence[str] | None,
         *_: dict,
     ) -> None:
+        """Initialize the Subdivisions instance."""
         self._locales = locales
         super().__init__()
 

geoip2/webservice.py

@@ -62,6 +62,8 @@
 
 
 class BaseClient:  # pylint: disable=missing-class-docstring, too-few-public-methods
+    """Base class for AsyncClient and Client."""
+
     _account_id: str
     _host: str
     _license_key: str
@@ -291,6 +293,7 @@ def __init__(  # pylint: disable=too-many-arguments,too-many-positional-argument
         timeout: float = 60,
         proxy: str | None = None,
     ) -> None:
+        """Initialize AsyncClient."""
         super().__init__(
             account_id,
             license_key,
@@ -460,6 +463,7 @@ def __init__(  # pylint: disable=too-many-arguments,too-many-positional-argument
         timeout: float = 60,
         proxy: str | None = None,
     ) -> None:
+        """Initialize Client."""
         super().__init__(account_id, license_key, host, locales, timeout)
         self._session = requests.Session()
         self._session.auth = (self._account_id, self._license_key)