Skip to content

gh-95273: Improve sqlite3.complete_statement docs #95840

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 6 commits into from
Aug 11, 2022
Merged

gh-95273: Improve sqlite3.complete_statement docs #95840

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2d3b7f1
gh-95273: Improve sqlite3.complete_statement docs
erlend-aasland Aug 9, 2022
31b60fb
Address review
erlend-aasland Aug 10, 2022
4c85590
Typo
Aug 10, 2022
e612289
Address review: add trivial example
Aug 11, 2022
887879f
Add comments to CLI so it serves better as an example
erlend-aasland Aug 11, 2022
44ddf4a
Address review and relocate example
erlend-aasland Aug 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
gh-95273: Improve sqlite3.complete_statement docs
  • Loading branch information
@erlend-aasland
erlend-aasland committed Aug 9, 2022
commit 2d3b7f10363a091e17767427e7b50c05d61af573
33 changes: 0 additions & 33 deletions Doc/includes/sqlite3/complete_statement.py
View file
Open in desktop

This file was deleted.

14 changes: 8 additions & 6 deletions Doc/library/sqlite3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,14 +222,16 @@ Module functions

.. function:: complete_statement(statement)

Returns ``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.
Return ``True`` if the string *statement* appears to contain one or more
complete SQL statements terminated by semicolons.
No syntactic verification or parsing of any kind is performed.
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated

This can be used to build a shell for SQLite, as in the following example:
This function may be useful during command-line input
to determine if the entered text seems to form a complete SQL statement,
or if additional input is needed before :meth:`executing <Cursor.execute>`
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
the statement.

.. literalinclude:: ../includes/sqlite3/complete_statement.py
See :source:`Lib/sqlite3/__main__.py` for example use.
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated

.. function:: enable_callback_tracebacks(flag, /)

Expand Down