gh-87260: Update sqlite3 signature docs to reflect actual implementation (#93840)

Align the docs for the following methods with the actual implementation:

- sqlite3.complete_statement()
- sqlite3.Connection.create_function()
- sqlite3.Connection.create_aggregate()
- sqlite3.Connection.set_progress_handler()
This commit is contained in:
Erlend Egeberg Aasland 2022-06-15 12:28:24 +02:00 committed by GitHub
parent 7e9eaad864
commit d31834688b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 9 deletions

View file

@ -336,9 +336,9 @@ Module functions and constants
float, str or bytes.
.. function:: complete_statement(sql)
.. function:: complete_statement(statement)
Returns :const:`True` if the string *sql* contains one or more complete SQL
Returns :const:`True` if the string *statement* contains one or more complete SQL
statements terminated by semicolons. It does not verify that the SQL is
syntactically correct, only that there are no unclosed string literals and the
statement is terminated by a semicolon.
@ -457,11 +457,11 @@ Connection Objects
:meth:`~Cursor.executescript` on it with the given *sql_script*.
Return the new cursor object.
.. method:: create_function(name, num_params, func, *, deterministic=False)
.. method:: create_function(name, narg, func, *, deterministic=False)
Creates a user-defined function that you can later use from within SQL
statements under the function name *name*. *num_params* is the number of
parameters the function accepts (if *num_params* is -1, the function may
statements under the function name *name*. *narg* is the number of
parameters the function accepts (if *narg* is -1, the function may
take any number of arguments), and *func* is a Python callable that is
called as the SQL function. If *deterministic* is true, the created function
is marked as `deterministic <https://sqlite.org/deterministic.html>`_, which
@ -480,12 +480,12 @@ Connection Objects
.. literalinclude:: ../includes/sqlite3/md5func.py
.. method:: create_aggregate(name, num_params, aggregate_class)
.. method:: create_aggregate(name, n_arg, aggregate_class)
Creates a user-defined aggregate function.
The aggregate class must implement a ``step`` method, which accepts the number
of parameters *num_params* (if *num_params* is -1, the function may take
of parameters *n_arg* (if *n_arg* is -1, the function may take
any number of arguments), and a ``finalize`` method which will return the
final result of the aggregate.
@ -580,7 +580,7 @@ Connection Objects
Added support for disabling the authorizer using :const:`None`.
.. method:: set_progress_handler(handler, n)
.. method:: set_progress_handler(progress_handler, n)
This routine registers a callback. The callback is invoked for every *n*
instructions of the SQLite virtual machine. This is useful if you want to
@ -588,7 +588,7 @@ Connection Objects
a GUI.
If you want to clear any previously installed progress handler, call the
method with :const:`None` for *handler*.
method with :const:`None` for *progress_handler*.
Returning a non-zero value from the handler function will terminate the
currently executing query and cause it to raise a :exc:`DatabaseError`

View file

@ -0,0 +1 @@
Align :mod:`sqlite3` argument specs with the actual implementation.