PEP8 / Pylint cleanups.

Author: behackett

pymongo/collection.py

@@ -37,15 +37,19 @@
 from pymongo.message import _INSERT, _UPDATE, _DELETE
 from pymongo.options import ReturnDocument, _WriteOp
 from pymongo.read_preferences import ReadPreference
-from pymongo.results import *
+from pymongo.results import (BulkWriteResult,
+                             DeleteResult,
+                             InsertOneResult,
+                             InsertManyResult,
+                             UpdateResult)
 from pymongo.write_concern import WriteConcern
 
 
 try:
     from collections import OrderedDict
-    ordered_types = (SON, OrderedDict)
+    _ORDERED_TYPES = (SON, OrderedDict)
 except ImportError:
-    ordered_types = SON
+    _ORDERED_TYPES = (SON,)
 
 _NO_OBJ_ERROR = "No matching object found"
 
@@ -146,7 +150,7 @@ def __init__(self, database, name, create=False, codec_options=None,
     def _command(
             self, command, read_preference=None, codec_options=None, **kwargs):
         """Internal command helper.
-        
+
         :Parameters:
           - `command` - The command itself, as a SON instance.
           - `read_preference` (optional) - An subclass of
@@ -200,9 +204,8 @@ def __repr__(self):
 
     def __eq__(self, other):
         if isinstance(other, Collection):
-            us = (self.__database, self.__name)
-            them = (other.__database, other.__name)
-            return us == them
+            return (self.__database == other.database and
+                    self.__name == other.name)
         return NotImplemented
 
     def __ne__(self, other):
@@ -334,20 +337,24 @@ def _insert(self, docs, ordered=True,
 
         if manipulate:
             def gen():
-                db = self.__database
+                """Generator that applies SON manipulators to each document
+                and adds _id if necessary.
+                """
+                _db = self.__database
                 for doc in docs:
                     # Apply user-configured SON manipulators. This order of
                     # operations is required for backwards compatibility,
                     # see PYTHON-709.
-                    doc = db._apply_incoming_manipulators(doc, self)
+                    doc = _db._apply_incoming_manipulators(doc, self)
                     if '_id' not in doc:
                         doc['_id'] = ObjectId()
 
-                    doc = db._apply_incoming_copying_manipulators(doc, self)
+                    doc = _db._apply_incoming_copying_manipulators(doc, self)
                     ids.append(doc['_id'])
                     yield doc
         else:
             def gen():
+                """Generator that only tracks existing _ids."""
                 for doc in docs:
                     ids.append(doc.get('_id'))
                     yield doc
@@ -1312,8 +1319,8 @@ def aggregate(self, pipeline, **kwargs):
             }
         return CommandCursor(self, cursor_info, address)
 
-    # TODO key and condition ought to be optional, but deprecation
-    # could be painful as argument order would have to change.
+    # key and condition ought to be optional, but deprecation
+    # would be painful as argument order would have to change.
     def group(self, key, condition, initial, reduce, finalize=None, **kwargs):
         """Perform a query similar to an SQL *group by* operation.
 
@@ -1747,10 +1754,10 @@ def find_and_modify(self, query={}, update=None,
                       ", find_one_and_replace, or find_one_and_update instead",
                       DeprecationWarning, stacklevel=2)
 
-        if (not update and not kwargs.get('remove', None)):
+        if not update and not kwargs.get('remove', None):
             raise ValueError("Must either update or remove")
 
-        if (update and kwargs.get('remove', None)):
+        if update and kwargs.get('remove', None):
             raise ValueError("Can't do both update and remove")
 
         # No need to include empty args
@@ -1766,16 +1773,16 @@ def find_and_modify(self, query={}, update=None,
                 kwargs['sort'] = helpers._index_document(sort)
             # Accept OrderedDict, SON, and dict with len == 1 so we
             # don't break existing code already using find_and_modify.
-            elif (isinstance(sort, ordered_types) or
+            elif (isinstance(sort, _ORDERED_TYPES) or
                   isinstance(sort, dict) and len(sort) == 1):
                 warnings.warn("Passing mapping types for `sort` is deprecated,"
                               " use a list of (key, direction) pairs instead",
                               DeprecationWarning, stacklevel=2)
                 kwargs['sort'] = sort
             else:
                 raise TypeError("sort must be a list of (key, direction) "
-                                 "pairs, a dict of len 1, or an instance of "
-                                 "SON or OrderedDict")
+                                "pairs, a dict of len 1, or an instance of "
+                                "SON or OrderedDict")
 
 
         fields = kwargs.pop("fields", None)
@@ -1806,10 +1813,10 @@ def find_and_modify(self, query={}, update=None,
     def __iter__(self):
         return self
 
-    def next(self):
+    def __next__(self):
         raise TypeError("'Collection' object is not iterable")
 
-    __next__ = next
+    next = __next__
 
     def __call__(self, *args, **kwargs):
         """This is only here so that some API misusages are easier to debug.

pymongo/common.py

@@ -298,6 +298,7 @@ def validate_auth_mechanism_properties(option, value):
 
 
 def validate_document_class(option, value):
+    """Validate the document_class option."""
     if not issubclass(value, collections.MutableMapping):
         raise ConfigurationError("%s must be a sublass of "
                                  "collections.MutableMapping" % (option,))

pymongo/cursor.py

@@ -236,6 +236,7 @@ def clone(self):
         return self._clone(True)
 
     def _clone(self, deepcopy=True):
+        """Internal clone helper."""
         clone = self._clone_base()
         values_to_clone = ("spec", "projection", "skip", "limit",
                            "max_time_ms", "comment", "max", "min",
@@ -800,7 +801,7 @@ def where(self, code):
         self.__spec["$where"] = code
         return self
 
-    def __send_message(self, message):
+    def __send_message(self, msg):
         """Send a query or getmore message and handles the response.
 
         If message is ``None`` this is an exhaust cursor, which reads
@@ -811,7 +812,7 @@ def __send_message(self, message):
         """
         client = self.__collection.database.connection
 
-        if message:
+        if msg:
             kwargs = {
                 "read_preference": self.__read_preference,
                 "exhaust": self.__exhaust,
@@ -820,7 +821,7 @@ def __send_message(self, message):
                 kwargs["address"] = self.__address
 
             try:
-                response = client._send_message_with_response(message, **kwargs)
+                response = client._send_message_with_response(msg, **kwargs)
                 self.__address = response.address
                 if self.__exhaust:
                     # 'response' is an ExhaustResponse.
@@ -873,7 +874,7 @@ def __send_message(self, message):
         self.__id = doc["cursor_id"]
 
         # starting from doesn't get set on getmore's for tailable cursors
-        if not (self.__query_flags & _QUERY_OPTIONS["tailable_cursor"]):
+        if not self.__query_flags & _QUERY_OPTIONS["tailable_cursor"]:
             assert doc["starting_from"] == self.__retrieved, (
                 "Result batch started from %s, expected %s" % (
                     doc['starting_from'], self.__retrieved))
@@ -970,20 +971,20 @@ def address(self):
     def __iter__(self):
         return self
 
-    def next(self):
+    def __next__(self):
         if self.__empty:
             raise StopIteration
-        db = self.__collection.database
+        _db = self.__collection.database
         if len(self.__data) or self._refresh():
             if self.__manipulate:
-                return db._fix_outgoing(self.__data.popleft(),
-                                        self.__collection)
+                return _db._fix_outgoing(self.__data.popleft(),
+                                         self.__collection)
             else:
                 return self.__data.popleft()
         else:
             raise StopIteration
 
-    __next__ = next
+    next = __next__
 
     def __enter__(self):
         return self

pymongo/database.py

@@ -116,6 +116,7 @@ def add_son_manipulator(self, manipulator):
         """
         base = SONManipulator()
         def method_overwritten(instance, method):
+            """Test if this method has been overridden."""
             return (getattr(
                 instance, method).__func__ != getattr(base, method).__func__)
 
@@ -188,9 +189,8 @@ def outgoing_copying_manipulators(self):
 
     def __eq__(self, other):
         if isinstance(other, Database):
-            us = (self.__connection, self.__name)
-            them = (other.__connection, other.__name)
-            return us == them
+            return (self.__connection == other.connection and
+                    self.__name == other.name)
         return NotImplemented
 
     def __ne__(self, other):
@@ -296,11 +296,13 @@ def create_collection(self, name, codec_options=None,
                           read_preference, write_concern, **kwargs)
 
     def _apply_incoming_manipulators(self, son, collection):
+        """Apply incoming manipulators to `son`."""
         for manipulator in self.__incoming_manipulators:
             son = manipulator.transform_incoming(son, collection)
         return son
 
     def _apply_incoming_copying_manipulators(self, son, collection):
+        """Apply incoming copying manipulators to `son`."""
         for manipulator in self.__incoming_copying_manipulators:
             son = manipulator.transform_incoming(son, collection)
         return son
@@ -523,7 +525,7 @@ def validate_collection(self, name_or_collection,
                 if "result" in res:
                     info = res["result"]
                     if (info.find("exception") != -1 or
-                        info.find("corrupt") != -1):
+                            info.find("corrupt") != -1):
                         raise CollectionInvalid("%s invalid: "
                                                 "%s" % (name, info))
                 elif not res.get("valid", False):
@@ -694,12 +696,13 @@ def reset_error_history(self):
     def __iter__(self):
         return self
 
-    def next(self):
+    def __next__(self):
         raise TypeError("'Database' object is not iterable")
 
-    __next__ = next
+    next = __next__
 
     def _default_role(self, read_only):
+        """Return the default user role for this database."""
         if self.name == "admin":
             if read_only:
                 return "readAnyDatabase"
@@ -775,7 +778,7 @@ def _legacy_add_user(self, name, password, read_only, **kwargs):
             # First admin user add fails gle from mongos 2.0.x
             # and 2.2.x.
             elif (exc.details and
-                    'getlasterror' in exc.details.get('note', '')):
+                  'getlasterror' in exc.details.get('note', '')):
                 pass
             else:
                 raise