Skip to content

Commit 5dee1d8

Browse files
gh-87260: Update sqlite3 signature docs to reflect actual implementation (GH-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() (cherry picked from commit d318346) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
1 parent 56ee410 commit 5dee1d8

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

Doc/library/sqlite3.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -308,9 +308,9 @@ Module functions and constants
308308
float, str or bytes.
309309

310310

311-
.. function:: complete_statement(sql)
311+
.. function:: complete_statement(statement)
312312

313-
Returns :const:`True` if the string *sql* contains one or more complete SQL
313+
Returns :const:`True` if the string *statement* contains one or more complete SQL
314314
statements terminated by semicolons. It does not verify that the SQL is
315315
syntactically correct, only that there are no unclosed string literals and the
316316
statement is terminated by a semicolon.
@@ -394,11 +394,11 @@ Connection Objects
394394
:meth:`~Cursor.executescript` on it with the given *sql_script*.
395395
Return the new cursor object.
396396

397-
.. method:: create_function(name, num_params, func, *, deterministic=False)
397+
.. method:: create_function(name, narg, func, *, deterministic=False)
398398

399399
Creates a user-defined function that you can later use from within SQL
400-
statements under the function name *name*. *num_params* is the number of
401-
parameters the function accepts (if *num_params* is -1, the function may
400+
statements under the function name *name*. *narg* is the number of
401+
parameters the function accepts (if *narg* is -1, the function may
402402
take any number of arguments), and *func* is a Python callable that is
403403
called as the SQL function. If *deterministic* is true, the created function
404404
is marked as `deterministic <https://sqlite.org/deterministic.html>`_, which
@@ -417,12 +417,12 @@ Connection Objects
417417
.. literalinclude:: ../includes/sqlite3/md5func.py
418418

419419

420-
.. method:: create_aggregate(name, num_params, aggregate_class)
420+
.. method:: create_aggregate(name, n_arg, aggregate_class)
421421

422422
Creates a user-defined aggregate function.
423423

424424
The aggregate class must implement a ``step`` method, which accepts the number
425-
of parameters *num_params* (if *num_params* is -1, the function may take
425+
of parameters *n_arg* (if *n_arg* is -1, the function may take
426426
any number of arguments), and a ``finalize`` method which will return the
427427
final result of the aggregate.
428428

@@ -479,15 +479,15 @@ Connection Objects
479479
one. All necessary constants are available in the :mod:`sqlite3` module.
480480

481481

482-
.. method:: set_progress_handler(handler, n)
482+
.. method:: set_progress_handler(progress_handler, n)
483483

484484
This routine registers a callback. The callback is invoked for every *n*
485485
instructions of the SQLite virtual machine. This is useful if you want to
486486
get called from SQLite during long-running operations, for example to update
487487
a GUI.
488488

489489
If you want to clear any previously installed progress handler, call the
490-
method with :const:`None` for *handler*.
490+
method with :const:`None` for *progress_handler*.
491491

492492
Returning a non-zero value from the handler function will terminate the
493493
currently executing query and cause it to raise an :exc:`OperationalError`
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Align :mod:`sqlite3` argument specs with the actual implementation.

0 commit comments

Comments
 (0)