Changeset 797

Timestamp:

03/06/07 22:43:41 (1 year ago)

Author:

mfenniak

Message:

Begin adding library documentation.

Files:

• pg8000/trunk/pg8000.py (modified) (5 diffs)

pg8000/trunk/pg8000.py

@@ +1 @@
+# vim: sw=4:expandtab:foldmethod=marker
+#
+# Copyright (c) 2007, Mathieu Fenniak
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+# * Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# * The name of the author may not be used to endorse or promote products
+# derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+__author__ = "Mathieu Fenniak"
+
-import socket
-import struct
@@ -52 +83 @@
-        return retval
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-class Connection(object):
-
+    ##
+    # A configuration variable that determines whether iterating over the
+    # connection will return tuples of queried rows (False), or dictionaries
+    # indexed by column name/alias (True).  By default, this variable is set to
+    # False.
+    # <p>
+    # Stability: Added in v1.00, stability guaranteed for v1.xx.
-    iterate_dicts = False
-
@@ -78 +144 @@
-        return tuple([Types.convert(row.fields[i], self._row_desc.fields[i]) for i in range(len(row.fields))])
-
+    ##
+    # Read a row from the database server, and return it in a dictionary
+    # indexed by column name/alias.  This method will raise an error if two
+    # columns have the same name.
+    # <p>
+    # Stability: Added in v1.00, stability guaranteed for v1.xx.
-    def read_dict(self):
-        row = self._fetch()
@@ -90 +162 @@
-        return retval
-
+    ##
+    # Read a row from the database server, and return it as a tuple of values.
+    # <p>
+    # Stability: Added in v1.00, stability guaranteed for v1.xx.
-    def read_tuple(self):
-        row = self._fetch()
@@ -96 +172 @@
-        return row
-
+    ##
+    # Iterate over query results.  The behaviour of iterating over this object
+    # is dependent upon the value of the {@link #Connection.iterate_dicts
+    # iterate_dicts} variable.
+    # <p>
+    # Stability: Added in v1.00, stability guaranteed for v1.xx.
-    def __iter__(self):
-        return DataIterator(self)