summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniele Varrazzo <daniele.varrazzo@gmail.com>2020-08-24 01:56:17 +0100
committerGitHub <noreply@github.com>2020-08-24 01:56:17 +0100
commitf7618f8bf5a59baddba9fcab4ca9e8e2ba53cb5b (patch)
treecd9d7c9de99310e88b18b79d1dc082257549fcf7
parent3aadecebaaa5f1c6f93515c32fb0005c52d7089b (diff)
parent96f0f63de25ed2ce6c9f5541ff8d36a64f18b599 (diff)
downloadpsycopg2-f7618f8bf5a59baddba9fcab4ca9e8e2ba53cb5b.tar.gz
Merge pull request #1120 from bashtanov/dictcursor-docs-improvement
DictCursor docs improvement
-rw-r--r--doc/src/extras.rst4
-rw-r--r--lib/extras.py5
2 files changed, 6 insertions, 3 deletions
diff --git a/doc/src/extras.rst b/doc/src/extras.rst
index bc47b30..eed049c 100644
--- a/doc/src/extras.rst
+++ b/doc/src/extras.rst
@@ -41,8 +41,8 @@ If you want to use a `!connection` subclass you can pass it as the
Dictionary-like cursor
^^^^^^^^^^^^^^^^^^^^^^
-The dict cursors allow to access to the retrieved records using an interface
-similar to the Python dictionaries instead of the tuples.
+The dict cursors allow to access to the attributes of retrieved records
+using an interface similar to the Python dictionaries instead of the tuples.
>>> dict_cur = conn.cursor(cursor_factory=psycopg2.extras.DictCursor)
>>> dict_cur.execute("INSERT INTO test (num, data) VALUES(%s, %s)",
diff --git a/lib/extras.py b/lib/extras.py
index ccb8b3f..135a3fb 100644
--- a/lib/extras.py
+++ b/lib/extras.py
@@ -130,7 +130,10 @@ class DictConnection(_connection):
class DictCursor(DictCursorBase):
- """A cursor that keeps a list of column name -> index mappings."""
+ """A cursor that keeps a list of column name -> index mappings__.
+
+ .. __: https://docs.python.org/glossary.html#term-mapping
+ """
def __init__(self, *args, **kwargs):
kwargs['row_factory'] = DictRow