← 返回首页
gh-87260: Update sqlite3 signature docs to reflect actual implementation by erlend-aasland · Pull Request #93840 · python/cpython · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erlend-aasland merged 2 commits into from
Jun 15, 2022
Conversation 4 Commits 2 Checks 0 Files changed
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
348b303
gh-87260: Update sqlite3 signature docs to reflect actual implementation
erlend-aasland Jun 15, 2022
cb8d2a9
Add NEWS
erlend-aasland Jun 15, 2022
File filter

Filter by extension

Filter by extension .rst  (2) All 1 file type selected Viewed files
Conversations
Failed to load comments. Retry
Loading
Jump to
Jump to file
Failed to load files. Retry
Loading
Diff view
Unified
Split
Hide whitespace
Apply and reload
Show whitespace
Diff view
Unified
Split
Hide whitespace
Apply and reload
18 changes: 9 additions & 9 deletions Doc/library/sqlite3.rst
Show comments
View file Edit file Delete file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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.

Expand Down Expand Up @@ -580,15 +580,15 @@ 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
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 a :exc:`DatabaseError`
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2022-06-15-12-12-49.gh-issue-87260.epyI7D.rst
Show comments
View file Edit file Delete file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Align :mod:`sqlite3` argument specs with the actual implementation.
Toggle all file notes Toggle all file annotations

Footer

© 2026 GitHub, Inc.