sqlite3_hat 0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at https://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
@@ -0,0 +1,29 @@
1
+ Metadata-Version: 2.5
2
+ Name: sqlite3_hat
3
+ Version: 0.1
4
+ Summary: Lightweight wrapper with improvements on sqlite3
5
+ Author-email: Thomas Kluyver <takluyver@fastmail.com>
6
+ Requires-Python: >=3.12
7
+ Description-Content-Type: text/x-rst
8
+ License-Expression: MPL-2.0
9
+ License-File: LICENSE
10
+ Project-URL: Documentation, https://sqlite3-hat.readthedocs.io/en/latest/
11
+ Project-URL: Source, https://codeberg.org/takluyver/sqlite3_hat
12
+ Import-Name: sqlite3_hat
13
+
14
+ ``sqlite3_hat`` is a small, pure Python wrapper to improve the ``sqlite3``
15
+ module from the standard library.
16
+
17
+ ``sqlite3_hat`` adds (or changes):
18
+
19
+ - Nested transaction support, using SQLite savepoints
20
+ - Autocommit is on (see why autocommit)
21
+ - Foreign key enforcement is on
22
+ - Non-standard double-quoted string syntax is disabled by default
23
+ - Convenient way to open a database read-only
24
+ - Parameters can be supplied in t-strings, or as ``*args`` rather than tuples
25
+ - Shortcut ``.queryone()`` method for getting a single row
26
+
27
+ The API is very similar to ``sqlite3``, but it's not a complete drop-in
28
+ replacement.
29
+
@@ -0,0 +1,15 @@
1
+ ``sqlite3_hat`` is a small, pure Python wrapper to improve the ``sqlite3``
2
+ module from the standard library.
3
+
4
+ ``sqlite3_hat`` adds (or changes):
5
+
6
+ - Nested transaction support, using SQLite savepoints
7
+ - Autocommit is on (see why autocommit)
8
+ - Foreign key enforcement is on
9
+ - Non-standard double-quoted string syntax is disabled by default
10
+ - Convenient way to open a database read-only
11
+ - Parameters can be supplied in t-strings, or as ``*args`` rather than tuples
12
+ - Shortcut ``.queryone()`` method for getting a single row
13
+
14
+ The API is very similar to ``sqlite3``, but it's not a complete drop-in
15
+ replacement.
@@ -0,0 +1,15 @@
1
+ [build-system]
2
+ requires = ["flit_core >=3.11,<5"]
3
+ build-backend = "flit_core.buildapi"
4
+
5
+ [project]
6
+ name = "sqlite3_hat"
7
+ authors = [{name = "Thomas Kluyver", email = "takluyver@fastmail.com"}]
8
+ readme = "README.rst"
9
+ license = "MPL-2.0"
10
+ requires-python = ">=3.12"
11
+ dynamic = ["version", "description"]
12
+
13
+ [project.urls]
14
+ Source = "https://codeberg.org/takluyver/sqlite3_hat"
15
+ Documentation = "https://sqlite3-hat.readthedocs.io/en/latest/"
@@ -0,0 +1,431 @@
1
+ """Lightweight wrapper with improvements on sqlite3"""
2
+
3
+ # This Source Code Form is subject to the terms of the Mozilla Public
4
+ # License, v. 2.0. If a copy of the MPL was not distributed with this
5
+ # file, You can obtain one at https://mozilla.org/MPL/2.0/.
6
+
7
+ import itertools
8
+ import os
9
+ import re
10
+ import sqlite3
11
+ import urllib.parse
12
+ from collections.abc import Iterable
13
+ from contextlib import contextmanager
14
+ from sqlite3 import Cursor
15
+
16
+ try: # t-strings added in Python 3.14
17
+ from string.templatelib import (
18
+ Template as _Template, Interpolation as _Interpolation
19
+ )
20
+ except ImportError:
21
+ # Fallback: allow isinstance() checks -> False
22
+ class _Template(type):
23
+ strings = ('',)
24
+ class _Interpolation(type): pass
25
+
26
+
27
+ __version__ = "0.1"
28
+
29
+ __all__ = [
30
+ "Connection",
31
+ "Cursor",
32
+ "NoResultsError",
33
+ "connect",
34
+ ]
35
+
36
+
37
+ class NoResultsError(sqlite3.Error):
38
+ """Error raised by queryone() when no results are returned"""
39
+ pass
40
+
41
+
42
+ def single_value(obj):
43
+ return (not isinstance(obj, Iterable)) or isinstance(obj, (str, bytes))
44
+
45
+
46
+ class TransactionHandle:
47
+ """An interface to a BEGIN transaction, returned from .transaction()"""
48
+ def __init__(self, conn: 'Connection'):
49
+ self.conn = conn
50
+ self.closed = False
51
+
52
+ def rollback(self):
53
+ """Revert any changes in this transaction & close the transaction"""
54
+ self.conn.rollback()
55
+ self.closed = True
56
+
57
+ def commit(self):
58
+ """Commit any changes in this transaction & close the transaction"""
59
+ self.conn.commit()
60
+ self.closed = True
61
+
62
+ def __enter__(self):
63
+ return self
64
+
65
+ def __exit__(self, exc_type, exc_val, exc_tb):
66
+ if not self.closed:
67
+ if exc_type is None:
68
+ self.commit()
69
+ else:
70
+ self.rollback()
71
+
72
+
73
+ class SavepointHandle(TransactionHandle):
74
+ """An interface to a SAVEPOINT transaction, returned from .savepoint()"""
75
+ def __init__(self, conn: 'Connection', name: str):
76
+ super().__init__(conn)
77
+ self.name = name
78
+
79
+ def rollback(self):
80
+ """Revert any changes in this transaction
81
+
82
+ The transaction remains open (with no changes) after calling this.
83
+ """
84
+ self.conn.rollback(self.name)
85
+ # ROLLBACK TO savepoint does not close the savepoint
86
+
87
+ def commit(self):
88
+ """Commit any changes in this transaction & close the transaction"""
89
+ self.conn.commit(self.name)
90
+ self.closed = True
91
+
92
+ def __exit__(self, exc_type, exc_val, exc_tb):
93
+ if not self.closed:
94
+ # after rollback, commit/release the savepoint to fully drop it
95
+ if exc_type is not None:
96
+ self.rollback()
97
+ self.commit()
98
+
99
+
100
+ class Connection(sqlite3.Connection):
101
+ def __init__(self, *args, **kwargs):
102
+ super().__init__(*args, **kwargs)
103
+ self.transaction_stack = []
104
+ self._ctx_stack = []
105
+ self._savept_counter = itertools.count()
106
+
107
+ @property # Prevent changing the autocommit state
108
+ def autocommit(self):
109
+ return True
110
+
111
+ def transaction(self, mode="IMMEDIATE"):
112
+ """Start a new BEGIN style transaction.
113
+
114
+ :param str mode: IMMEDIATE (the default), EXCLUSIVE or DEFERRED.
115
+
116
+ This may be used as a context manager. The changes will be rolled back
117
+ if an error is raised, or committed on exit if not::
118
+
119
+ with conn.transaction("IMMEDIATE"):
120
+ ...
121
+
122
+ BEGIN can only be used when a transaction is not already active, so
123
+ the main use case for this is with IMMEDIATE or EXCLUSIVE to start a
124
+ write transaction immediately. If you don't need this, use savepoint
125
+ instead for nestable transactions.
126
+ """
127
+ if mode.upper() not in ("DEFERRED", "IMMEDIATE", "EXCLUSIVE"):
128
+ raise ValueError(f"Invalid mode {mode!r}")
129
+ self.execute(f"BEGIN {mode}")
130
+ handle = TransactionHandle(self)
131
+ self.transaction_stack.append(handle)
132
+ return handle
133
+
134
+ def savepoint(self, name=None):
135
+ """Start a SAVEPOINT transaction.
136
+
137
+ :param name: A name for this savepoint. If None (the default), use an
138
+ automatic name based on a counter.
139
+ :type name: str or None
140
+
141
+ This may be used as a context manager, or equivalently, the connection
142
+ object itself can be used as a context manager, making a new savepoint
143
+ on each use::
144
+
145
+ with conn: # Outer transaction
146
+ with conn: # Inner transaction
147
+ ...
148
+
149
+ Each transaction will be committed or rolled back depending on whether
150
+ it exits with an error. No changes are permanent until the outermost
151
+ transaction is committed.
152
+ """
153
+ if name is None:
154
+ name = f"py_auto_savept_{next(self._savept_counter)}"
155
+ self.execute(f"SAVEPOINT {quote_name(name)}")
156
+ handle = SavepointHandle(self, name)
157
+ self.transaction_stack.append(handle)
158
+ return handle
159
+
160
+ def _find_savept(self, name):
161
+ for i, txn in enumerate(reversed(self.transaction_stack), start=1):
162
+ if isinstance(txn, SavepointHandle) and txn.name == name:
163
+ return len(self.transaction_stack) - i
164
+ raise KeyError(name)
165
+
166
+ def _drop_inner_transactions(self, from_ix):
167
+ # A transaction has been committed or rolled back. Any inner savepoints
168
+ # are committed/rolled back automatically, so we can deactivate our handles
169
+ txns = self.transaction_stack[from_ix:]
170
+ self.transaction_stack[from_ix:] = []
171
+ for txn in txns:
172
+ txn.closed = True
173
+
174
+ def rollback(self, savept_name=None):
175
+ """Roll back a transaction
176
+
177
+ :param savept_name: The name of a savepoint, or None to roll back all
178
+ active transactions.
179
+ :type savept_name: str or None
180
+
181
+ Any nested transactions within the specified one are also rolled back.
182
+ In most cases, it's more convenient to use the context manager API.
183
+ """
184
+ if savept_name is None:
185
+ super().execute("ROLLBACK")
186
+ self._drop_inner_transactions(0)
187
+ else:
188
+ self.execute(f"ROLLBACK TO {quote_name(savept_name)}")
189
+ ix = self._find_savept(savept_name)
190
+ # ROLLBACK TO returns to just after the savepoint was created,
191
+ # so that savepoint is still on the stack
192
+ self._drop_inner_transactions(ix + 1)
193
+
194
+ def commit(self, savept_name=None):
195
+ """Commit a transaction
196
+
197
+ :param savept_name: The name of a savepoint, or None to commit all
198
+ active transactions.
199
+ :type savept_name: str or None
200
+
201
+ Any nested transactions within the specified one are also committed.
202
+ In most cases, it's more convenient to use the context manager API.
203
+ """
204
+ if savept_name is None:
205
+ super().execute("COMMIT")
206
+ self._drop_inner_transactions(0)
207
+ else:
208
+ self.execute(f"RELEASE {quote_name(savept_name)}")
209
+ ix = self._find_savept(savept_name)
210
+ self._drop_inner_transactions(ix)
211
+
212
+ def __enter__(self):
213
+ self._ctx_stack.append(self.savepoint())
214
+ return self
215
+
216
+ def __exit__(self, exc_type, exc_val, exc_tb):
217
+ self._ctx_stack.pop().__exit__(exc_type, exc_val, exc_tb)
218
+
219
+ @staticmethod
220
+ def _template_to_sql_params(tmpl: _Template) -> str:
221
+ if not tmpl.strings[0].strip():
222
+ raise ValueError("SQL statement cannot start with a parameter")
223
+ if any(not s.strip() for s in tmpl.strings[1:]):
224
+ raise ValueError("Two parameters separated only by whitespace")
225
+
226
+ return "?".join(tmpl.strings)
227
+
228
+ def execute(self, sql, *parameters):
229
+ """Execute an SQL query and return a Cursor object
230
+
231
+ :param sql: String query, possibly containing placeholders, or a template
232
+ string using templating for parameters.
233
+ :type sql: str or template string
234
+ :param parameters: Optional parameters matching placeholders in SQL
235
+ string. May be passed as separate positional parameters, or a single
236
+ tuple or dict. Not used if ``sql`` is a query string.
237
+ """
238
+ if isinstance(sql, _Template):
239
+ if parameters:
240
+ raise TypeError("Cannot combine template string and separate SQL parameters")
241
+
242
+ parameters = sql.values
243
+ sql = self._template_to_sql_params(sql)
244
+
245
+ elif len(parameters) == 1 and not single_value(parameters[0]):
246
+ parameters = parameters[0]
247
+
248
+ return super().execute(sql, parameters)
249
+
250
+ def _convert_executemany_template(self, obj):
251
+ it = iter(obj)
252
+ try:
253
+ tmpl0 = next(it)
254
+ except StopIteration: # 0 entries is valid; nothing to do
255
+ return None, ()
256
+
257
+ if not isinstance(tmpl0, _Template):
258
+ raise TypeError("Iterable argument to executemany() must contain template strings")
259
+
260
+ def params_iter():
261
+ yield tmpl0.values
262
+ for tmpl in it:
263
+ if not isinstance(tmpl, _Template):
264
+ raise TypeError("Iterable argument to executemany() must contain template strings")
265
+ if tmpl.strings != tmpl0.strings:
266
+ raise TypeError("Template strings for executemany() must all have the same template")
267
+
268
+ yield tmpl.values
269
+
270
+ return self._template_to_sql_params(tmpl0), params_iter()
271
+
272
+ def executemany(self, sql, parameters=None, /):
273
+ """Execute an SQL query with multiple sets of parameters
274
+
275
+ :param sql: String query containing placeholders, or an iterable
276
+ of template strings. In the latter case, the fixed part of all
277
+ template strings must be the same, with only the parameters changing.
278
+ :param parameters: Iterable of parameters to use with placeholders in
279
+ string query. Each entry may be a single value, a tuple or dict.
280
+ Not used if the first parameter is an iterable of template strings.
281
+ """
282
+ if parameters is None:
283
+ if isinstance(sql, str):
284
+ raise TypeError("SQL string requires parameters sequence")
285
+
286
+ sql, parameters = self._convert_executemany_template(sql)
287
+ if sql is None:
288
+ return None
289
+
290
+ else:
291
+ def wrap_tuples(param_it):
292
+ for pt in param_it:
293
+ if isinstance(pt, (str, bytes)) or not isinstance(pt, Iterable):
294
+ pt = (pt,)
295
+ yield pt
296
+
297
+ parameters = wrap_tuples(parameters)
298
+
299
+ return super().executemany(sql, parameters)
300
+
301
+ def queryone(self, sql, *parameters, default=None):
302
+ """Execute a query and return a single row as a result.
303
+
304
+ :param sql: String query, possibly containing placeholders, or a template
305
+ string using templating for parameters.
306
+ :type sql: str or template string
307
+ :param parameters: As in :meth:`execute`.
308
+ :param default: Fallback value to return if there are no results.
309
+ If not specified, raise :exc:`NoResultsError`.
310
+ """
311
+ cur = self.execute(sql, parameters)
312
+ row = cur.fetchone()
313
+ cur.close()
314
+ if row is None:
315
+ if default is None:
316
+ raise NoResultsError("Query returned no results")
317
+ return default
318
+ return row
319
+
320
+
321
+ def make_uri(database, is_uri: bool, mode="rwc", win=(os.name == "nt")):
322
+ if mode not in ("ro", "rw", "rwc", "memory"):
323
+ raise ValueError("mode must be ro / rw / rwc / memory")
324
+ if is_uri:
325
+ up = urllib.parse.urlsplit(database)
326
+ if up.scheme not in ("file", b"file"):
327
+ raise ValueError("Database URLs must use the file: scheme")
328
+ path = up.path
329
+ params = urllib.parse.parse_qs(up.query)
330
+ else:
331
+ path = os.fspath(database)
332
+ if win:
333
+ path = os.fsdecode(path)
334
+ path = path.replace("\\", "/")
335
+ if path[1] == ":":
336
+ if path[2] != "/":
337
+ raise ValueError(
338
+ "Cannot convert Windows drive + relative path to file: URI"
339
+ )
340
+ path = "/" + path
341
+
342
+ if isinstance(path, bytes):
343
+ path = re.sub(b"/+", b"/", path).replace(b"?", b"%3f").replace(b"#", b"%23")
344
+ else: # str
345
+ path = re.sub("/+", "/", path).replace("?", "%3f").replace("#", "%23")
346
+ params = {}
347
+
348
+ params["mode"] = [mode]
349
+ query = urllib.parse.urlencode(params, doseq=True)
350
+
351
+ if isinstance(path, bytes):
352
+ return urllib.parse.urlunsplit((b"file", b"", path, query.encode(), b""))
353
+ return urllib.parse.urlunsplit(("file", "", path, query, ""))
354
+
355
+
356
+ def quote_name(name: str) -> str:
357
+ """Quote an identifier to be safely used within an SQL statement.
358
+
359
+ This takes a name, e.g. for a table or column, and wraps it so it can be
360
+ combined into an SQL statement, even if the name contains spaces etc.
361
+ This is sometimes necessary since names can't usually be parameters.
362
+ Used correctly, it can prevent SQL injection.
363
+
364
+ This is not idempotent: passing an already-quoted name will add further
365
+ quotes, changing the meaning. Any quoted name is itself valid as a different
366
+ logical name: it is possible to have one table called ``a`` and another
367
+ called ``"a"``. To avoid confusion, try to pass around logical names where
368
+ possible, and quote only when assembling an SQL statement.
369
+ """
370
+ return '"{}"'.format(name.replace('"', '""'))
371
+
372
+
373
+ def connect(database, *, mode="rwc", uri=False, dqs=False, **kwargs):
374
+ """Open an SQLite database connection.
375
+
376
+ :param database: Database file to connect to. May be an sqlite URI if ``uri=True``.
377
+ :type database: str or os.PathLike
378
+ :param str mode: "rwc" (read-write-create), "rw" (read-write) or "ro" (read-only)
379
+ :param bool uri: Whether the first argument is an SQLite URI.
380
+ :param bool dqs: Allow double-quoted string literals.
381
+ :param float timeout: Maximum time in seconds to wait when getting a lock
382
+ on the database. If the timeout expires, OperationalError is raised.
383
+ :param int cached_statements: Size of cache for compiled SQL statements.
384
+ Default 128.
385
+ :param int check_same_thread: As in sqlite3 module.
386
+ :param int detect_types: As in sqlite3 module.
387
+
388
+ """
389
+ if eka := set(kwargs) - {
390
+ "timeout",
391
+ "detect_types",
392
+ "cached_statements",
393
+ "check_same_thread",
394
+ }:
395
+ raise TypeError(f"Unexpected keyword arguments: {eka}")
396
+ if mode != "rwc":
397
+ database = make_uri(database, uri, mode)
398
+ uri = True
399
+
400
+ conn = sqlite3.connect(
401
+ database,
402
+ autocommit=True,
403
+ uri=uri,
404
+ factory=Connection,
405
+ **kwargs,
406
+ )
407
+
408
+ # Defend against SQL statements that can corrupt the DB
409
+ conn.setconfig(sqlite3.SQLITE_DBCONFIG_DEFENSIVE, True)
410
+ # Optionally disable Double Quoted String. String literals must use 'single quotes'
411
+ conn.setconfig(sqlite3.SQLITE_DBCONFIG_DQS_DDL, dqs)
412
+ conn.setconfig(sqlite3.SQLITE_DBCONFIG_DQS_DML, dqs)
413
+
414
+ # Enable foreign key enforcement
415
+ conn.execute("PRAGMA foreign_keys = TRUE;")
416
+
417
+ return conn
418
+
419
+
420
+ @contextmanager
421
+ def open(database, **kwargs):
422
+ """Context manager to conveniently open & close an SQLite database.
423
+
424
+ The parameters are the same as :func:`connect`. When leaving the block,
425
+ the database is closed.
426
+ """
427
+ conn = connect(database, **kwargs)
428
+ try:
429
+ yield conn
430
+ finally:
431
+ conn.close()