Add missing docstrings and update CPYINT revision

nmariz · nmariz · commit 97aa93ecd8e2 · 2016-06-16T18:25:33.000+01:00
diff --git a/cpyint b/cpyint
@@ -1 +1 @@
-Subproject commit 6316398bd095a8507cc7f7f63ea5eb1dc4fa8aee
+Subproject commit 5e2061ef798afe693a50e5287f88a924d2f605d5
diff --git a/lib/mysqlx/__init__.py b/lib/mysqlx/__init__.py
@@ -31,9 +31,10 @@
 from .result import (ColumnMetaData, Row, Result, BufferingResult, RowResult,
                      SqlResult, ColumnType)
 from .statement import (Statement, FilterableStatement, SqlStatement,
-                        AddStatement, RemoveStatement, ModifyStatement,
-                        SelectStatement, InsertStatement, DeleteStatement,
-                        UpdateStatement, CreateCollectionIndexStatement,
+                        FindStatement, AddStatement, RemoveStatement,
+                        ModifyStatement, SelectStatement, InsertStatement,
+                        DeleteStatement, UpdateStatement,
+                        CreateCollectionIndexStatement,
                         DropCollectionIndexStatement)
 from .dbdoc import DbDoc
 
@@ -76,11 +77,11 @@ def get_node_session(settings):
 
     # mysqlx.result
     "ColumnMetaData", "Row", "Result", "BufferingResult", "RowResult",
-    "SqlResult",
+    "SqlResult", "ColumnType",
 
     # mysqlx.statement
     "DbDoc", "Statement", "FilterableStatement", "SqlStatement",
-    "AddStatement", "RemoveStatement", "ModifyStatement", "SelectStatement",
-    "InsertStatement", "DeleteStatement", "UpdateStatement",
+    "FindStatement", "AddStatement", "RemoveStatement", "ModifyStatement",
+    "SelectStatement", "InsertStatement", "DeleteStatement", "UpdateStatement",
     "CreateCollectionIndexStatement", "DropCollectionIndexStatement",
 ]
diff --git a/lib/mysqlx/connection.py b/lib/mysqlx/connection.py
@@ -198,7 +198,7 @@ def rollback(self):
 
 
 class XSession(BaseSession):
-    """Enables interaction with an X Protocol enabled MySQL Product.
+    """Enables interaction with a X Protocol enabled MySQL Product.
 
     The functionality includes:
 
@@ -215,7 +215,7 @@ def __init__(self, settings):
 
 
 class NodeSession(BaseSession):
-    """Enables interaction with an X Protocol enabled MySQL Server.
+    """Enables interaction with a X Protocol enabled MySQL Server.
 
     The functionality includes:
 
diff --git a/lib/mysqlx/result.py b/lib/mysqlx/result.py
@@ -519,6 +519,12 @@ def Message(self):
 
 
 class Row(object):
+    """Represents a row element returned from a SELECT query.
+
+    Args:
+        rs (mysqlx.Result): The Result set.
+        fields (list): The list of fields.
+    """
     def __init__(self, rs, fields):
         self._fields = fields
         self._resultset = rs
@@ -531,6 +537,11 @@ def __getitem__(self, index):
         return self._fields[index]
 
     def get_string(self, str_index):
+        """Returns the value if the index by string.
+
+        Args:
+            str_index (str): The string index.
+        """
         int_index = self._resultset.index_of(str_index)
         if int_index >= len(self._fields):
             raise IndexError("Argument out of range")
@@ -540,6 +551,11 @@ def get_string(self, str_index):
 
 
 class BaseResult(object):
+    """Provides base functionality for result objects.
+
+    Args:
+        connection (mysqlx.connection.Connection): The Connection object.
+    """
     def __init__(self, connection):
         self._connection = connection
         self._protocol = self._connection.protocol
@@ -552,32 +568,63 @@ def __init__(self, connection):
             connection._active_result = None
 
     def get_warnings(self):
+        """Returns the warnings.
+
+        Returns:
+            list: The list of warnings.
+        """
         return self._warnings
 
     def get_warnings_count(self):
+        """Returns the number of warnings.
+
+        Returns:
+            int: The number of warnings.
+        """
         return len(self._warnings)
 
 
 class Result(BaseResult):
+    """Allows retrieving information about non query operations performed on
+    the database.
+
+    Args:
+        connection (mysqlx.connection.Connection): The Connection object.
+        ids (list): A list of IDs.
+    """
     def __init__(self, connection, ids=None):
         super(Result, self).__init__(connection)
         self._ids = ids
         self._protocol.close_result(self)
 
     def get_affected_items_count(self):
+        """Returns the number of affected items for the last operation.
+
+        Returns:
+            int: The number of affected items.
+        """
         return self._rows_affected
 
     def get_autoincrement_value(self):
+        """Returns the last insert id auto generated.
+
+        Returns:
+            int: The last insert id.
+        """
         return self._generated_id
 
     def get_document_id(self):
+        """Returns ID of the last document inserted into a collection.
+        """
         if self._ids is None:
             return None
         if len(self._ids) == 0:
             return None
         return self._ids[0]
 
     def get_document_ids(self):
+        """Returns the list of generated documents IDs.
+        """
         return self._ids
 
 
@@ -596,12 +643,19 @@ def _init_result(self):
 
     @property
     def count(self):
+        """int: The total of items.
+        """
         return len(self._items)
 
     def __getitem__(self, index):
         return self._items[index]
 
     def index_of(self, col_name):
+        """Returns the index of the column.
+
+        Returns:
+            int: The index of the column.
+        """
         index = 0
         for col in self._columns:
             if col.get_column_name() == col_name:
@@ -634,27 +688,46 @@ def _page_in_items(self):
         return count
 
     def fetch_all(self):
+        """Fetch all items.
+
+        Returns:
+            list: The list of items.
+        """
         while True:
             if not self._page_in_items():
                 break
         return self._items
 
 
 class RowResult(BufferingResult):
+    """Allows traversing the Row objects returned by a Table.select operation.
+
+    Args:
+        connection (mysqlx.connection.Connection): The Connection object.
+    """
     def __init__(self, connection):
         super(RowResult, self).__init__(connection)
 
     @property
     def columns(self):
+        """list: The list of columns.
+        """
         return self._columns
 
 
 class SqlResult(RowResult):
+    """Represents a result from a SQL statement.
+
+    Args:
+        connection (mysqlx.connection.Connection): The Connection object.
+    """
     def __init__(self, connection):
         super(SqlResult, self).__init__(connection)
         self._has_more_results = False
 
     def get_autoincrement_value(self):
+        """Returns the identifier for the last record inserted.
+        """
         return self._generated_id
 
     def next_result(self):
@@ -666,6 +739,12 @@ def next_result(self):
 
 
 class DocResult(BufferingResult):
+    """Allows traversing the DbDoc objects returned by a Collection.find
+    operation.
+
+    Args:
+        connection (mysqlx.connection.Connection): The Connection object.
+    """
     def __init__(self, connection):
         super(DocResult, self).__init__(connection)
 
diff --git a/lib/mysqlx/statement.py b/lib/mysqlx/statement.py
@@ -146,6 +146,15 @@ def _having(self, condition):
         self._having = ExprParser(condition, not self._doc_based).expr()
 
     def bind(self, *args):
+        """Binds a value to a specific placeholder.
+
+        Args:
+            *args: The name of the placeholder and the value to bind.
+                   A :class:`mysqlx.DbDoc` object or a JSON string
+                   representation can be used.
+        Raises:
+            ProgrammingError: If the number of arguments is invalid.
+        """
         self._has_bindings = True
         count = len(args)
         if count == 1:
