classification
Title: Wrong arguments in sqlite3.connect() documentation
Type: Stage: needs patch
Components: Documentation Versions: Python 3.1, Python 3.2, Python 2.7, Python 2.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: georg.brandl, vstinner
Priority: normal Keywords:

Created on 2010-03-13 03:13 by vstinner, last changed 2010-07-29 22:25 by vstinner. This issue is now closed.

Messages (2)
msg100987 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2010-03-13 03:13
Python documentation has the prototype:

sqlite3.connect(database[, timeout, isolation_level, detect_types, factory])

http://docs.python.org/library/sqlite3.html#sqlite3.connect

Source code:

 - sqlite.rst: .. function:: connect(database[, timeout, isolation_level, detect_types, factory])
 - connect() documentation: connect(database[, 
timeout, isolation_level, detect_types, factory])
 - module_connect(): char *kwlist[] = {"database", "timeout", "detect_types", "isolation_level", "check_same_thread", "factory", "cached_statements", NULL, NULL};
 - pysqlite_connection_init(): char *kwlist[] = {"database", "timeout", "detect_types", "isolation_level", "check_same_thread", "factory", "cached_statements", NULL, NULL};

module_connect() and pysqlite_connection_init() use the same keyword list, but the documentation invert arguments detect_types and isolation_level, and miss check_same_thread and cached_statements arguments.

--

Example:

>>> import sqlite3
>>> con=sqlite3.connect(':memory:', 2.0, 'DEFER')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: an integer is required
>>> con=sqlite3.connect(':memory:', 2.0, True)
>>> con=sqlite3.connect(':memory:', 2.0, isolation_level='DEFER')

The third argument is a boolean, it's the detect_types option (not the isolation level, a string).
msg112018 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2010-07-29 22:25
I was trying to fix but, but... oh! Georg fixed that 2 weeks ago (r82763). Thank you!
History
Date User Action Args
2010-07-29 22:25:11vstinnersetstatus: open -> closed
resolution: fixed
messages: + msg112018
2010-03-13 09:21:31floxsetpriority: normal
stage: needs patch
2010-03-13 03:13:39vstinnercreate