Skip to content

Commit

Permalink
gh-87260: Update sqlite3 signature docs to reflect actual implementat…
Browse files Browse the repository at this point in the history
…ion (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>
  • Loading branch information
miss-islington and erlend-aasland authored Jun 15, 2022
1 parent 56ee410 commit 5dee1d8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
18 changes: 9 additions & 9 deletions Doc/library/sqlite3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -308,9 +308,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.
Expand Down Expand Up @@ -394,11 +394,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
Expand All @@ -417,12 +417,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.

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


.. 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
get called from SQLite during long-running operations, for example to update
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 an :exc:`OperationalError`
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Align :mod:`sqlite3` argument specs with the actual implementation.

0 comments on commit 5dee1d8

Please sign in to comment.