diff options
author | Berker Peksag <berker.peksag@gmail.com> | 2016-03-27 18:51:02 (GMT) |
---|---|---|
committer | Berker Peksag <berker.peksag@gmail.com> | 2016-03-27 18:51:02 (GMT) |
commit | f70fe6f6cfde596264ed6fdd626b8c2964443f3e (patch) | |
tree | cdda74cef7bf88623e6e3620d364111752897868 | |
parent | 557a06309c212d0218191253afe020df01133c1f (diff) | |
download | cpython-f70fe6f6cfde596264ed6fdd626b8c2964443f3e.zip cpython-f70fe6f6cfde596264ed6fdd626b8c2964443f3e.tar.gz cpython-f70fe6f6cfde596264ed6fdd626b8c2964443f3e.tar.bz2 |
Document sqlite3.Cursor.close()
The behaviour of the close method is tested by ClosedCurTests
in Lib/sqlite3/test/dbapi.py.
This is basically a backport of https://github.com/ghaering/pysqlite/issues/73.
-rw-r--r-- | Doc/library/sqlite3.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst index c5a5e81..4890fc5 100644 --- a/Doc/library/sqlite3.rst +++ b/Doc/library/sqlite3.rst @@ -593,6 +593,12 @@ Cursor Objects the cursor's arraysize attribute can affect the performance of this operation. An empty list is returned when no rows are available. + .. method:: close() + + Close the cursor now (rather than whenever ``__del__`` is called). + + The cursor will be unusable from this point forward; a ``ProgrammingError`` + exception will be raised if any operation is attempted with the cursor. .. attribute:: rowcount |