Skip to content

bpo-45677: Reword first section of sqlite3 docs #29326

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
willingc merged 14 commits into from
Nov 15, 2021
+24 −22
Merged

bpo-45677: Reword first section of sqlite3 docs #29326

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
af15b22
bpo-45677: Avoid addressing the reader as 'you' in sqlite3 docs
Oct 29, 2021
c1e758d
Adjust wording
Oct 29, 2021
204052c
Adjust wording again
Oct 29, 2021
02d2a53
Typo
Oct 29, 2021
15008ee
Update Doc/library/sqlite3.rst
Oct 31, 2021
4d53130
Address review: adjust wording
Oct 31, 2021
f5ce4af
Update Doc/library/sqlite3.rst
Oct 31, 2021
e9c3e97
Update Lib/sqlite3/__init__.py
Oct 31, 2021
86efc85
Update Doc/library/sqlite3.rst
Oct 31, 2021
6923fee
Update Doc/library/sqlite3.rst
Oct 31, 2021
c794d16
Update Lib/sqlite3/__init__.py
Oct 31, 2021
f405915
Update Doc/library/sqlite3.rst
Oct 31, 2021
d451f9d
Apply Alex' suggestion, and apply 80 char limit to PR
Oct 31, 2021
9bd8121
Minor adjustment
Oct 31, 2021
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
Prev Previous commit
Next Next commit
Adjust wording again
  • Loading branch information
Erlend E. Aasland committed Oct 29, 2021
commit 204052c630ae896abf5a4dd2417007a42e83125b
19 changes: 10 additions & 9 deletions Doc/library/sqlite3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,15 +83,16 @@ vulnerable to an SQL injection attacks (see the `xkcd webcomic
cur.execute("SELECT * FROM stocks WHERE symbol = '%s'" % symbol)

Instead, use the DB-API's parameter substitution by putting placeholders in the
query string. Provide the values as a :class:`tuple` via the second argument of
the cursor's :meth:`~Cursor.execute` method. An SQL statement may use one of two
kinds of placeholders: question marks (qmark style) or named placeholders (named
style). For the qmark style, ``parameters`` must be a :term:`sequence
<sequence>`. For the named style, it can be either a :term:`sequence <sequence>`
or :class:`dict` instance. The length of the :term:`sequence <sequence>` must
match the number of placeholders, or a :exc:`ProgrammingError` is raised. If a
:class:`dict` is given, it must contain keys for all named parameters. Any extra
items are ignored. Here's an example of both styles:
query string. Provide the actual values as a :class:`tuple` as the second
argument oo the cursor's :meth:`~Cursor.execute` method. An SQL statement may
use one of two kinds of placeholders: question marks (qmark style) or named
placeholders (named style). For the qmark style, ``parameters`` must be a
:term:`sequence <sequence>`. For the named style, it can be either a
:term:`sequence <sequence>` or :class:`dict` instance. The length of the
:term:`sequence <sequence>` must match the number of placeholders, or a
:exc:`ProgrammingError` is raised. If a :class:`dict` is given, it must contain
keys for all named parameters. Any extra items are ignored. Here's an example of
both styles:

.. literalinclude:: ../includes/sqlite3/execute_1.py

Expand Down