Commit Graph

232 Commits

Author SHA1 Message Date
Serhiy Storchaka b338ac7540
[3.11] gh-106909: Use role :const: for referencing module constants (GH-106910) (GH-106957)
(cherry picked from commit 4b9948617f)
2023-07-21 14:49:57 +03:00
Miss Islington (bot) 247f0500b8
[3.11] gh-96165: Clarify passing ":memory:" in sqlite3.connect() (GH-106451) (#106648)
cherry picked from commit f520804b03)

Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2023-07-11 22:32:08 +02:00
Miss Islington (bot) 6d8662381d
[3.11] gh-96165: Clarify omitting the FROM clause in SQLite queries (GH-106513) (#106646)
(cherry picked from commit fc7ff1af45)

Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2023-07-11 22:30:52 +02:00
Miss Islington (bot) 1bbf60dc31
[3.11] Docs: add links to 'callable' term in sqlite3 docs (GH-106072) (#106074)
(cherry picked from commit bef1c8761e)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-06-25 10:16:30 +02:00
Erlend E. Aasland 7055088500
[3.11] gh-101117: Improve accuracy of sqlite3.Cursor.rowcount docs (#104287) (#104381)
The SQLite C API sqlite3_changes() can only be relied upon when the
current active statement has been run to completion.
2023-05-11 11:09:46 +02:00
Erlend E. Aasland b3faf8ceec
[3.11] gh-100021: Document that sqlite3's executemany() discards resulting rows (#103939) (#103966) 2023-04-28 08:05:14 +00:00
Adam Turner dbc44fab7a
[3.11] GH-103903: Test the minimum Sphinx version in CI (#103904) (#103948)
[3.11] GH-103903: Test the minimum Sphinx version in CI (GH-103904).

(cherry picked from commit 44b5c21f41)
2023-04-27 20:55:09 +00:00
Miss Islington (bot) 592c34469b
Docs: improve accuracy of sqlite3.Connection.interrupt() (GH-102904)
(cherry picked from commit 7b2d53dacc)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-22 05:00:25 -07:00
Miss Islington (bot) 9a1453b651
Docs: improve the accuracy of the sqlite3.connect() timeout param (GH-102900)
(cherry picked from commit c24f1f1e87)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-22 04:49:46 -07:00
Alex Waygood 3b1201daf6
[3.11] Fix typos in documentation and comments (GH-102374) (#102376)
[3.11] Fix typos in documentation and comments (GH-102374)

Found some duplicate `to`s in the documentation and some code comments and fixed them.

[Misc/NEWS.d/3.12.0a1.rst](ed55c69ebd/Misc/NEWS.d/3.12.0a1.rst) also contains two duplicate `to`s, but I wasn't sure if it's ok to touch that file.  Looks auto generated.  I'm happy to amend the PR if requested. :)

Automerge-Triggered-By: GH:AlexWaygood

Co-authored-by: Michael K <michael-k@users.noreply.github.com>
2023-03-02 16:00:06 +00:00
Miss Islington (bot) 18313ecb09
Docs: use parameter list for sqlite3.Cursor.execute* (GH-101782)
(cherry picked from commit 2037ebf81b)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-02-10 10:01:38 -08:00
Miss Islington (bot) c2c970fc26
Docs: improve accuracy of sqlite3 `check_same_thread` parameter (GH-101351)
(cherry picked from commit ee21110086)

Co-authored-by: Marcos Pereira <3464445+marcospgp@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-02-01 16:00:27 -08:00
Miss Islington (bot) db65a326a4
Docs: improve sqlite3 placeholders example (GH-101092)
(cherry picked from commit b84be8d9c0)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2023-01-18 01:43:44 -08:00
Miss Islington (bot) c7aa39286b
gh-100668: Clarify how sqlite3 maps parameters onto placeholders (GH-100960)
(cherry picked from commit 206f05a46b)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-01-14 15:04:53 -08:00
Miss Islington (bot) e7a2659b4c
gh-99953: Purge mention of numeric param style from sqlite3 docs (GH-100630)
The PEP-249 numeric style has never been supported by sqlite3.
(cherry picked from commit b7a68ab824)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2023-01-01 14:35:39 -08:00
Miss Islington (bot) ecb16d5d63
gh-96250: Improve sqlite3 injection attack example (GH-99270)
(cherry picked from commit 41d4ac9da3)

Co-authored-by: Jia Junjie <62194633+jiajunjie@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-12-08 12:45:40 -08:00
Miss Islington (bot) f160996412
Docs: both sqlite3 "point examples" now adapt to str (GH-99823)
(cherry picked from commit 276643e207)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-11-27 13:21:00 -08:00
Miss Islington (bot) 5b7408490f
gh-96168: Add sqlite3 row factory how-to (GH-99507)
(cherry picked from commit 8749121b07)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-11-25 05:15:09 -08:00
Miss Islington (bot) edf744990e
gh-99392: Fix sqlite3 converter recipes (GH-99393)
(cherry picked from commit dfc1b17a23)

Co-authored-by: naglis <827324+naglis@users.noreply.github.com>
2022-11-12 11:48:52 -08:00
Miss Islington (bot) 2ef2eaac15
Docs: add `named` to the list of styles in the sqlite3.paramstyle attr docs (GH-99078)
(cherry picked from commit 016c7d37b6)

Co-authored-by: Nick Pope <nick@nickpope.me.uk>
2022-11-03 16:27:53 -07:00
Miss Islington (bot) 78df56ec69
gh-98716: Revert gh-96081: Escape lone stars in sqlite3 docs (GH-98720)
(cherry picked from commit 365852a03a)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-10-26 08:01:54 -07:00
Miss Islington (bot) 79b5c1ad3c
gh-97661: Improve accuracy of sqlite3.Cursor.fetchone docs (GH-97662)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 4b83cd0b22)

Co-authored-by: Jia Junjie <62194633+jiajunjie@users.noreply.github.com>
2022-10-05 01:57:30 -07:00
Miss Islington (bot) 9ab9e82b86
gh-96810: Clarify for which statements sqlite3 implicitly opens transactions (GH-96832)
(cherry picked from commit 16c33a9676)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-09-15 14:21:08 -07:00
Miss Islington (bot) b31b1b1248
gh-96702: Order methods before attrs in sqlite3.Connection docs (GH-96703) (#96788)
(cherry picked from commit 49cceeb5c9)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-09-14 21:56:14 +02:00
Miss Islington (bot) 0c81909a7a
Docs: alphabetically order sqlite3.Cursor attrs (GH-96565)
(cherry picked from commit 9e55685782)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-09-04 14:43:23 -07:00
Miss Islington (bot) fca8e94dbf
gh-96168: Improve sqlite3 dict_factory example (GH-96457)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 91f40f3f78)

Co-authored-by: Erlend E. Aasland <erlend.aasland@innova.no>
2022-09-01 14:55:37 -07:00
Miss Islington (bot) d4d5e605cd
gh-96414: Inline code examples in sqlite3 docs (GH-96442)
(cherry picked from commit f7e7bf161a)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-30 23:03:33 -07:00
Miss Islington (bot) 895c7a4401
Docs: normalise sqlite3 placeholder how-to heading (GH-96413)
(cherry picked from commit 7b01ce7953)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-30 14:06:11 -07:00
Miss Islington (bot) 4cfb6395e1
Docs: normalize SQL style in sqlite3 docs (GH-96403)
(cherry picked from commit 6d403e264a)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-29 15:59:13 -07:00
Miss Islington (bot) 2ba877258a
gh-95432: Add doctests for the sqlite3 docs (GH-96225)
As a consequence of the added test, this commit also includes
fixes for broken examples.

- Add separate namespace for trace tests bco. module level callback
- Move more backup and cursor examples under separate namespaces
(cherry picked from commit bf9259776d)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-29 02:01:37 -07:00
Erlend E. Aasland 2b8fd74548
[3.11] gh-94635: Frame sqlite3 how-to headings as such & move default adapters to reference (GH-96136) (#96226)
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>.
(cherry picked from commit 6bda5b85b5)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-08-24 09:51:46 +02:00
Miss Islington (bot) dc6391705e
gh-96096: Add undocumented SQLITE_OK/DENY/IGNORE sqlite3 constants (GH-96134)
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit d6259c58cb)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-08-22 23:58:35 -07:00
Miss Islington (bot) 88a559ffea
gh-95432: Add doctest for sqlite3 tutorial (GH-96193)
(cherry picked from commit 04c73e5efb)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-22 23:55:35 -07:00
Miss Islington (bot) 98622fa00e
gh-96121: Merge sqlite3.Row examples into sqlite3.Row class doc (GH-96122)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 18b1782192)

Co-authored-by: Erlend E. Aasland <erlend.aasland@innova.no>
2022-08-22 01:12:02 -07:00
Miss Islington (bot) fcf04217ab
Docs: Fix markup of module name in sqlite3 docs (GH-96115)
(cherry picked from commit ee9f22d346)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-19 01:26:08 -07:00
Miss Islington (bot) f21d7e5150
Doc: Use consistent markup for example Point class in sqlite3 (GH-96095)
(cherry picked from commit 303ef0913e)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-08-19 00:48:03 -07:00
Miss Islington (bot) eed7711547
Docs: group sqlite3.Connection attributes and methods (GH-96090)
(cherry picked from commit 1a140af40b)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-19 00:37:51 -07:00
Miss Islington (bot) c097fe0f09
gh-94635: Remove sqlite3 doc introduction heading (GH-96089)
(cherry picked from commit ede771cdf9)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-19 00:28:33 -07:00
Miss Islington (bot) e8e3fe9931
Docs: Escape lone stars in sqlite3 docs (GH-96081)
(cherry picked from commit 91afe66707)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-18 11:47:42 -07:00
Miss Islington (bot) 972150b8e3
gh-95271: Rework sqlite3 tutorial (GH-95749)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit c87ea10fc9)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-18 11:44:27 -07:00
Erlend E. Aasland bd86e09ab9
[3.11] gh-95273: Improve sqlite3.complete_statement docs (GH-95840) (#95917)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit e6623e7083)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-12 09:34:26 +02:00
Miss Islington (bot) 88cae1c9c6
gh-94635: Fixup sqlite3 'Introduction' seealso note (GH-95751) (#95752)
In gh-95269, the seealso note incorrectly ended up in
the 'Tutorial' section.
(cherry picked from commit 56af5a200d)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-09 13:48:08 +02:00
Erlend E. Aasland d7a6a97806
[3.11] gh-95273: Reorganize sqlite3 doc module level funcs and vars (GH-95626) (#95801)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 41c939cb35)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-09 13:47:15 +02:00
Erlend Egeberg Aasland 7dc0dafdf0
[3.11] Docs: sqlite3 docs fixup (GH-95681) (GH-95683)
- Disable links to the module itself
- Fix link indent
- Consistent ref markup.
(cherry picked from commit 44f1f63ad5)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-08-05 09:41:54 +02:00
Erlend Egeberg Aasland 4d37b42295
[3.11] gh-95271: Extract placeholders howto from sqlite3 tutorial (GH-95522) (#95677)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit b24e8b28a7)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-08-04 23:02:28 +02:00
Erlend Egeberg Aasland c9986be733
[3.11] gh-95273: Improve documented return values and exceptions raised for sqlite3 class methods (GH-95530) (#95673)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 12d92c733c)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-08-04 22:13:22 +02:00
Miss Islington (bot) 33de1863fd
Docs: fix two typos in the sqlite3 docs (GH-95661)
- statment => statement
- transaciton => transaction
(cherry picked from commit 962acd4468)

Co-authored-by: ceh <emil@hessman.se>
2022-08-04 11:35:45 -07:00
Miss Islington (bot) 8d09626066
gh-95273: Align sqlite3 const doc refs with the devguide recommendations (GH-95525)
(cherry picked from commit 4d02572f8c)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-08-03 13:28:38 -07:00
Miss Islington (bot) ad2872f5fd
gh-95273: Clarify when sqlite_* attributes are added to sqlite3 exceptions (GH-95523)
(cherry picked from commit 1e6b63542e)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-08-01 02:22:09 -07:00
Erlend Egeberg Aasland c7ac8b6588
[3.11] gh-94635: Add Reference, How-to, and Explanation headings to sqlite3 docs (GH-94636) (#95482)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 6c439b978b)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>

* Fix refs
2022-07-31 08:48:13 +02:00