Minor code improvements

Author: nmariz

lib/mysqlx/authentication.py

@@ -21,6 +21,8 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
+"""Implementation of MySQL Authentication Plugin."""
+
 import hashlib
 
 

lib/mysqlx/connection.py

@@ -21,7 +21,7 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
-"""Implementation of MySQLx servers enabled communication."""
+"""Implementation of communication for MySQL X servers."""
 
 import socket
 

lib/mysqlx/crud.py

@@ -21,6 +21,8 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
+"""Implementation of the CRUD database objects."""
+
 from .statement import (FindStatement, AddStatement, RemoveStatement,
                         ModifyStatement, SelectStatement, InsertStatement,
                         DeleteStatement, UpdateStatement,

lib/mysqlx/dbdoc.py

@@ -21,6 +21,8 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
+"""Implementation of the DbDoc."""
+
 import json
 import uuid
 

lib/mysqlx/errors.py

@@ -21,8 +21,7 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
-"""Python Database API Specification v2.0 exceptions implementation.
-"""
+"""Implementation of the Python Database API Specification v2.0 exceptions."""
 
 import sys
 import struct

lib/mysqlx/protocol.py

@@ -21,6 +21,8 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
+"""Implementation of the X protocol for MySQL servers."""
+
 import struct
 
 from .protobuf import mysqlx_pb2 as MySQLx

lib/mysqlx/result.py

@@ -21,13 +21,17 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
+"""Implementation of the Result Set classes."""
+
 import decimal
 import struct
 import sys
 
 from datetime import datetime, timedelta
+
 from .dbdoc import DbDoc
 
+
 def from_protobuf(col_type, payload):
     if len(payload) == 0:
         return None
@@ -69,7 +73,7 @@ def double_from_protobuf(payload):
 
 def varint_from_protobuf_stream(payload):
     if len(payload) == 0:
-        raise ValueError("payload is empty")
+        raise ValueError("Payload is empty")
 
     cur = 0
     i = 0
@@ -86,21 +90,21 @@ def varint_from_protobuf_stream(payload):
         cur += 1
         shift += 7
 
-    raise EOFError("payload too short")
+    raise EOFError("Payload too short")
 
 
 def varint_from_protobuf(payload):
     i, payload = varint_from_protobuf_stream(payload)
     if len(payload) != 0:
-        raise ValueError("payload too long")
+        raise ValueError("Payload too long")
 
     return i
 
 
 def varsint_from_protobuf(payload):
     i, payload = varint_from_protobuf_stream(payload)
     if len(payload) != 0:
-        raise ValueError("payload too long")
+        raise ValueError("Payload too long")
 
     # Zigzag encoded, revert it
     if i & 0x1:
@@ -122,7 +126,7 @@ def set_from_protobuf(payload):
                 if len(payload) == 0 and field_len == 1 and len(s) == 0:
                     # Special case for empty set
                     return []
-                raise ValueError("invalid Set encoding")
+                raise ValueError("Invalid Set encoding")
 
             s.append(payload[:field_len])
             payload = payload[field_len:]
@@ -397,6 +401,7 @@ def is_padded(self):
         # TODO: To implement
         raise NotImplementedError
 
+
 class Warning(object):
     def __init__(self, level, code, msg):
         self._level = level
@@ -433,17 +438,18 @@ def get_string(self, str_index):
         if int_index >= len(self._fields):
             raise Exception("Argument out of range")
         if int_index == -1:
-            raise Exception("Column name '" + str_index + "' not found")
+            raise Exception("Column name '{0}' not found".format(str_index))
         return str(self._fields[int_index])
 
+
 class BaseResult(object):
     def __init__(self, connection):
         self._connection = connection
         self._protocol = self._connection.protocol
         self._closed = False
         self._rows_affected = 0
         self._warnings = []
-        if connection._active_result != None:
+        if connection._active_result is not None:
             connection._active_result.fetch_all()
             connection._active_result = None
 
@@ -454,6 +460,7 @@ def get_warnings(self):
     def get_warnings_count(self):
         return len(self._warnings)
 
+
 class Result(BaseResult):
     def __init__(self, connection):
         super(Result, self).__init__(connection)
@@ -467,6 +474,7 @@ def get_affected_items_count(self):
     def get_autoincrement_value(self):
         pass
 
+
 class BufferingResult(BaseResult):
     def __init__(self, connection):
         super(BufferingResult, self).__init__(connection)
@@ -478,7 +486,7 @@ def _init_result(self):
         self._items = []
         self._page_size = 20
         self._position = -1
-        self._connection._active_result = self if self._has_more_data == True else None
+        self._connection._active_result = self if self._has_more_data else None
 
     @property
     def count(self):
@@ -520,11 +528,12 @@ def _page_in_items(self):
         return count
 
     def fetch_all(self):
-        while (True):
+        while True:
             if not self._page_in_items():
                 break
         return self._items
 
+
 class RowResult(BufferingResult):
     def __init__(self, connection):
         super(RowResult, self).__init__(connection)
@@ -533,18 +542,20 @@ def __init__(self, connection):
     def columns(self):
         return self._columns
 
+
 class SqlResult(RowResult):
     def __init__(self, connection):
         super(SqlResult, self).__init__(connection)
         self._has_more_results = False
 
     def next_result(self):
-        if self._closed == True:
+        if self._closed:
             return False
         self._has_more_results = False
         self._init_result()
         return True
 
+
 class DocResult(BufferingResult):
     def __init__(self, connection):
         super(DocResult, self).__init__(connection)
@@ -554,4 +565,3 @@ def _read_item(self, dumping):
         if row is None:
             return None
         return DbDoc(row[0])
-

lib/mysqlx/statement.py

@@ -21,12 +21,14 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
+"""Implementation of Statements."""
 
 from .protobuf import mysqlx_crud_pb2 as MySQLxCrud
 from .result import SqlResult
 from .expr import ExprParser
 from .dbdoc import DbDoc
 
+
 class Statement(object):
     """Provides base functionality for statement objects.
 
@@ -98,7 +100,9 @@ def where(self, condition):
 
     def _projection(self, *fields):
         self._has_projection = True
-        self._projection_expr = ExprParser(",".join(fields), not self._doc_based).parse_table_select_projection()
+        self._projection_expr = ExprParser(
+            ",".join(fields),
+            not self._doc_based).parse_table_select_projection()
         return self
 
     def limit(self, row_count, offset=0):
@@ -120,12 +124,14 @@ def sort(self, *sort_clauses):
             *sort_clauses: The expression strings defining the sort criteria.
         """
         self._has_sort = True
-        self._sort_expr = ExprParser(",".join(sort_clauses), not self._doc_based).parse_order_spec()
+        self._sort_expr = ExprParser(",".join(sort_clauses),
+                                     not self._doc_based).parse_order_spec()
         return self
 
     def _group_by(self, *fields):
         self._has_group_by = True
-        self._grouping = ExprParser(",".join(fields), not self._doc_based).parse_expr_list()
+        self._grouping = ExprParser(",".join(fields),
+                                    not self._doc_based).parse_expr_list()
 
     def _having(self, condition):
         self._has_having = True
@@ -137,7 +143,7 @@ def execute(self):
         Raises:
            NotImplementedError: This method must be implemented.
         """
-        raise Exception("This should never be called")
+        raise NotImplementedError
 
 
 class SqlStatement(Statement):
@@ -198,23 +204,26 @@ def execute(self):
             doc.ensure_id()
         return self._connection.send_insert(self)
 
+
 class UpdateSpec(object):
-    def __init__(self, type, source, value=None):
-        if type == MySQLxCrud.UpdateOperation.SET:
+    def __init__(self, update_type, source, value=None):
+        if update_type == MySQLxCrud.UpdateOperation.SET:
             self._table_set(source, value)
         else:
-            self.update_type = type
+            self.update_type = update_type
             self.source = source
             if len(source) > 0 and source[0] == '$':
                 self.source = source[1:]
-            self.source = ExprParser(self.source, False).document_field().identifier
+            self.source = ExprParser(self.source,
+                                     False).document_field().identifier
             self.value = value
 
     def _table_set(self, source, value):
         self.update_type = MySQLxCrud.UpdateOperation.SET
         self.source = ExprParser(source, True).parse_table_update_field()
         self.value = value
 
+
 class ModifyStatement(FilterableStatement):
     """A statement for document update operations on a Collection.
 
@@ -224,7 +233,8 @@ class ModifyStatement(FilterableStatement):
                                    documents to be updated.
     """
     def __init__(self, collection, condition=None):
-        super(ModifyStatement, self).__init__(target=collection, condition=condition)
+        super(ModifyStatement, self).__init__(target=collection,
+                                              condition=condition)
         self._update_ops = []
 
     def set(self, doc_path, value):
@@ -237,7 +247,8 @@ def set(self, doc_path, value):
         Returns:
             mysqlx.ModifyStatement: ModifyStatement object.
         """
-        self._update_ops.append(UpdateSpec(MySQLxCrud.UpdateOperation.ITEM_SET, doc_path, value))
+        self._update_ops.append(
+            UpdateSpec(MySQLxCrud.UpdateOperation.ITEM_SET, doc_path, value))
         return self
 
     def change(self, doc_path, value):
@@ -251,7 +262,9 @@ def change(self, doc_path, value):
         Returns:
             mysqlx.ModifyStatement: ModifyStatement object.
         """
-        self._update_ops.append(UpdateSpec(MySQLxCrud.UpdateOperation.ITEM_REPLACE, doc_path, value))
+        self._update_ops.append(
+            UpdateSpec(MySQLxCrud.UpdateOperation.ITEM_REPLACE, doc_path,
+                       value))
         return self
 
     def unset(self, doc_path):
@@ -264,7 +277,8 @@ def unset(self, doc_path):
         Returns:
             mysqlx.ModifyStatement: ModifyStatement object.
         """
-        self._update_ops.append(UpdateSpec(MySQLxCrud.UpdateOperation.ITEM_REMOVE, doc_path))
+        self._update_ops.append(
+            UpdateSpec(MySQLxCrud.UpdateOperation.ITEM_REMOVE, doc_path))
         return self
 
     def array_insert(self, field, value):
@@ -279,7 +293,8 @@ def array_insert(self, field, value):
         Returns:
             mysqlx.ModifyStatement: ModifyStatement object.
         """
-        self._update_ops.append(UpdateSpec(MySQLxCrud.UpdateOperation.ARRAY_INSERT, field, value))
+        self._update_ops.append(
+            UpdateSpec(MySQLxCrud.UpdateOperation.ARRAY_INSERT, field, value))
         return self
 
     def array_append(self, doc_path, value):
@@ -295,7 +310,9 @@ def array_append(self, doc_path, value):
         Returns:
             mysqlx.ModifyStatement: ModifyStatement object.
         """
-        self._update_ops.append(UpdateSpec(MySQLxCrud.UpdateOperation.UpdateType.ARRAY_APPEND, doc_path, value))
+        self._update_ops.append(
+            UpdateSpec(MySQLxCrud.UpdateOperation.UpdateType.ARRAY_APPEND,
+                       doc_path, value))
         return self
 
     def execute(self):
@@ -442,6 +459,7 @@ def execute(self):
         """
         return self._connection.send_insert(self)
 
+
 class UpdateStatement(FilterableStatement):
     """A statement for record update operations on a Table.
 
@@ -460,7 +478,8 @@ def set(self, field, value):
             field (string): The column name to be updated.
             value (object): The value to be set on the specified column.
         """
-        self._update_ops.append(UpdateSpec(MySQLxCrud.UpdateOperation.SET, field, value))
+        self._update_ops.append(
+            UpdateSpec(MySQLxCrud.UpdateOperation.SET, field, value))
         return self
 
     def execute(self):
@@ -500,8 +519,8 @@ class DeleteStatement(FilterableStatement):
     """
     def __init__(self, table, condition=None):
         super(DeleteStatement, self).__init__(target=table,
-                                                   condition=condition,
-                                                   doc_based=False)
+                                              condition=condition,
+                                              doc_based=False)
 
     def execute(self):
         """Execute the statement.