Mailman 3 August 2022 - Python-checkins

gh-96096: Add undocumented SQLITE_OK/DENY/IGNORE sqlite3 constants (#96134)
by erlend-aasland Aug. 23, 2022

Aug. 23, 2022

https://github.com/python/cpython/commit/d6259c58cbb48b8f3fbd70047f004ea19f… commit: d6259c58cbb48b8f3fbd70047f004ea19fe91e86 branch: main author: C.A.M. Gerlach <CAM.Gerlach(a)Gerlach.CAM> committer: erlend-aasland <erlend.aasland(a)protonmail.com> date: 2022-08-23T08:51:20+02:00 summary: gh-96096: Add undocumented SQLITE_OK/DENY/IGNORE sqlite3 constants (#96134) Co-authored-by: Erlend E. Aasland <erlend.aasland(a)protonmail.com> Co-authored-by: Ezio Melotti <ezio.melotti(a)gmail.com> files: M Doc/library/sqlite3.rst diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst index de769f35dd3..798c2d795b1 100644 --- a/Doc/library/sqlite3.rst +++ b/Doc/library/sqlite3.rst @@ -447,6 +447,17 @@ Module constants This flag may be combined with :const:`PARSE_COLNAMES` using the ``|`` (bitwise or) operator. +.. data:: SQLITE_OK + SQLITE_DENY + SQLITE_IGNORE + + Flags that should be returned by the *authorizer_callback* callable + passed to :meth:`Connection.set_authorizer`, to indicate whether: + + * Access is allowed (:const:`!SQLITE_OK`), + * The SQL statement should be aborted with an error (:const:`!SQLITE_DENY`) + * The column should be treated as a ``NULL`` value (:const:`!SQLITE_IGNORE`) + .. data:: apilevel String constant stating the supported DB-API level. Required by the DB-API. @@ -822,10 +833,9 @@ Connection objects Register callable *authorizer_callback* to be invoked for each attempt to access a column of a table in the database. The callback should return - :const:`SQLITE_OK` if access is allowed, :const:`SQLITE_DENY` if the entire SQL - statement should be aborted with an error and :const:`SQLITE_IGNORE` if the - column should be treated as a NULL value. These constants are available in the - :mod:`!sqlite3` module. + one of :const:`SQLITE_OK`, :const:`SQLITE_DENY`, or :const:`SQLITE_IGNORE` + to signal how access to the column should be handled + by the underlying SQLite library. The first argument to the callback signifies what kind of operation is to be authorized. The second and third argument will be arguments or ``None``

1 0

gh-95432: Add doctest for sqlite3 tutorial (#96193)
by erlend-aasland Aug. 23, 2022

Aug. 23, 2022

https://github.com/python/cpython/commit/04c73e5efbfea8ae9da5bd518cee960860… commit: 04c73e5efbfea8ae9da5bd518cee96086017ef4f branch: main author: Erlend E. Aasland <erlend.aasland(a)protonmail.com> committer: erlend-aasland <erlend.aasland(a)protonmail.com> date: 2022-08-23T08:48:13+02:00 summary: gh-95432: Add doctest for sqlite3 tutorial (#96193) files: M Doc/library/sqlite3.rst diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst index 0d1185dd4658..de769f35dd3f 100644 --- a/Doc/library/sqlite3.rst +++ b/Doc/library/sqlite3.rst @@ -8,6 +8,15 @@ **Source code:** :source:`Lib/sqlite3/` +.. Make sure we always doctest the tutorial with an empty database. + +.. testsetup:: + + import sqlite3 + src = sqlite3.connect(":memory:", isolation_level=None) + dst = sqlite3.connect("tutorial.db", isolation_level=None) + src.backup(dst) + del src, dst .. _sqlite3-intro: @@ -65,7 +74,9 @@ First, we need to create a new database and open a database connection to allow :mod:`!sqlite3` to work with it. Call :func:`sqlite3.connect` to to create a connection to the database :file:`tutorial.db` in the current working directory, -implicitly creating it if it does not exist:: +implicitly creating it if it does not exist: + +.. testcode:: import sqlite3 con = sqlite3.connect("tutorial.db") @@ -75,7 +86,9 @@ represents the connection to the on-disk database. In order to execute SQL statements and fetch results from SQL queries, we will need to use a database cursor. -Call :meth:`con.cursor() <Connection.cursor>` to create the :class:`Cursor`:: +Call :meth:`con.cursor() <Connection.cursor>` to create the :class:`Cursor`: + +.. testcode:: cur = con.cursor() @@ -86,7 +99,9 @@ For simplicity, we can just use column names in the table declaration -- thanks to the `flexible typing`_ feature of SQLite, specifying the data types is optional. Execute the ``CREATE TABLE`` statement -by calling :meth:`cur.execute(...) <Cursor.execute>`:: +by calling :meth:`cur.execute(...) <Cursor.execute>`: + +.. testcode:: cur.execute("CREATE TABLE movie(title, year, score)") @@ -99,7 +114,9 @@ which should now contain an entry for the ``movie`` table definition (see `The Schema Table`_ for details). Execute that query by calling :meth:`cur.execute(...) <Cursor.execute>`, assign the result to ``res``, -and call :meth:`res.fetchone() <Cursor.fetchone>` to fetch the resulting row:: +and call :meth:`res.fetchone() <Cursor.fetchone>` to fetch the resulting row: + +.. doctest:: >>> res = cur.execute("SELECT name FROM sqlite_master") >>> res.fetchone() @@ -108,7 +125,9 @@ and call :meth:`res.fetchone() <Cursor.fetchone>` to fetch the resulting row:: We can see that the table has been created, as the query returns a :class:`tuple` containing the table's name. If we query ``sqlite_master`` for a non-existent table ``spam``, -:meth:`!res.fetchone()` will return ``None``:: +:meth:`!res.fetchone()` will return ``None``: + +.. doctest:: >>> res = cur.execute("SELECT name FROM sqlite_master WHERE name='spam'") >>> res.fetchone() is None @@ -116,7 +135,9 @@ If we query ``sqlite_master`` for a non-existent table ``spam``, Now, add two rows of data supplied as SQL literals by executing an ``INSERT`` statement, -once again by calling :meth:`cur.execute(...) <Cursor.execute>`:: +once again by calling :meth:`cur.execute(...) <Cursor.execute>`: + +.. testcode:: cur.execute(""" INSERT INTO movie VALUES @@ -128,7 +149,9 @@ The ``INSERT`` statement implicitly opens a transaction, which needs to be committed before changes are saved in the database (see :ref:`sqlite3-controlling-transactions` for details). Call :meth:`con.commit() <Connection.commit>` on the connection object -to commit the transaction:: +to commit the transaction: + +.. testcode:: con.commit() @@ -136,7 +159,9 @@ We can verify that the data was inserted correctly by executing a ``SELECT`` query. Use the now-familiar :meth:`cur.execute(...) <Cursor.execute>` to assign the result to ``res``, -and call :meth:`res.fetchall() <Cursor.fetchall>` to return all resulting rows:: +and call :meth:`res.fetchall() <Cursor.fetchall>` to return all resulting rows: + +.. doctest:: >>> res = cur.execute("SELECT score FROM movie") >>> res.fetchall() @@ -146,7 +171,9 @@ The result is a :class:`list` of two :class:`!tuple`\s, one per row, each containing that row's ``score`` value. Now, insert three more rows by calling -:meth:`cur.executemany(...) <Cursor.executemany>`:: +:meth:`cur.executemany(...) <Cursor.executemany>`: + +.. testcode:: data = [ ("Monty Python Live at the Hollywood Bowl", 1982, 7.9), @@ -164,14 +191,16 @@ to avoid `SQL injection attacks`_ We can verify that the new rows were inserted by executing a ``SELECT`` query, -this time iterating over the results of the query:: +this time iterating over the results of the query: + +.. doctest:: >>> for row in cur.execute("SELECT year, title FROM movie ORDER BY year"): ... print(row) - (1971, "And Now for Something Completely Different") - (1975, "Monty Python and the Holy Grail") + (1971, 'And Now for Something Completely Different') + (1975, 'Monty Python and the Holy Grail') (1979, "Monty Python's Life of Brian") - (1982, "Monty Python Live at the Hollywood Bowl") + (1982, 'Monty Python Live at the Hollywood Bowl') (1983, "Monty Python's The Meaning of Life") Each row is a two-item :class:`tuple` of ``(year, title)``, @@ -180,15 +209,17 @@ matching the columns selected in the query. Finally, verify that the database has been written to disk by calling :meth:`con.close() <Connection.close>` to close the existing connection, opening a new one, -creating a new cursor, then querying the database:: +creating a new cursor, then querying the database: + +.. doctest:: >>> con.close() >>> new_con = sqlite3.connect("tutorial.db") >>> new_cur = new_con.cursor() - >>> res = new_cur.execute("SELECT year, title FROM movie ORDER BY score DESC"): + >>> res = new_cur.execute("SELECT title, year FROM movie ORDER BY score DESC") >>> title, year = res.fetchone() >>> print(f'The highest scoring Monty Python movie is {title!r}, released in {year}') - 'The highest scoring Monty Python movie is "Monty Python and the Holy Grail", released in 1975' + The highest scoring Monty Python movie is 'Monty Python and the Holy Grail', released in 1975 You've now created an SQLite database using the :mod:`!sqlite3` module, inserted data and retrieved values from it in multiple ways.

1 0

gh-96159: Fix significant performance degradation in logging.TimedRotat… (GH-96182)
by vsajip Aug. 23, 2022

Aug. 23, 2022

https://github.com/python/cpython/commit/1499d73b3e02878850c007fa7298bb62f6… commit: 1499d73b3e02878850c007fa7298bb62f6c5a9a1 branch: main author: Duncan Grisby <duncan-github(a)grisby.org> committer: vsajip <vinay_sajip(a)yahoo.co.uk> date: 2022-08-23T07:28:43+01:00 summary: gh-96159: Fix significant performance degradation in logging.TimedRotat… (GH-96182) files: A Misc/NEWS.d/next/Library/2022-08-22-18-42-17.gh-issue-96159.3bFU39.rst M Lib/logging/handlers.py diff --git a/Lib/logging/handlers.py b/Lib/logging/handlers.py index 1c8226c18163..3f97862cc37a 100644 --- a/Lib/logging/handlers.py +++ b/Lib/logging/handlers.py @@ -348,11 +348,15 @@ def shouldRollover(self, record): record is not used, as we are just comparing times, but it is needed so the method signatures are the same """ - # See bpo-45401: Never rollover anything other than regular files - if os.path.exists(self.baseFilename) and not os.path.isfile(self.baseFilename): - return False t = int(time.time()) if t >= self.rolloverAt: + # See #89564: Never rollover anything other than regular files + if os.path.exists(self.baseFilename) and not os.path.isfile(self.baseFilename): + # The file is not a regular file, so do not rollover, but do + # set the next rollover time to avoid repeated checks. + self.rolloverAt = self.computeRollover(t) + return False + return True return False diff --git a/Misc/NEWS.d/next/Library/2022-08-22-18-42-17.gh-issue-96159.3bFU39.rst b/Misc/NEWS.d/next/Library/2022-08-22-18-42-17.gh-issue-96159.3bFU39.rst new file mode 100644 index 000000000000..f64469e563f3 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2022-08-22-18-42-17.gh-issue-96159.3bFU39.rst @@ -0,0 +1 @@ +Fix a performance regression in logging TimedRotatingFileHandler. Only check for special files when the rollover time has passed.

1 0

GH-96075: move interned dict under runtime state (GH-96077)
by miss-islington Aug. 22, 2022

Aug. 22, 2022

https://github.com/python/cpython/commit/129998bd7b133defa37c7529bfad9052c0… commit: 129998bd7b133defa37c7529bfad9052c0022b5c branch: main author: Kumar Aditya <59607654+kumaraditya303(a)users.noreply.github.com> committer: miss-islington <31488909+miss-islington(a)users.noreply.github.com> date: 2022-08-22T12:05:21-07:00 summary: GH-96075: move interned dict under runtime state (GH-96077) files: M Include/internal/pycore_global_objects.h M Objects/unicodeobject.c diff --git a/Include/internal/pycore_global_objects.h b/Include/internal/pycore_global_objects.h index 98673d4efce..82e89db7b1b 100644 --- a/Include/internal/pycore_global_objects.h +++ b/Include/internal/pycore_global_objects.h @@ -45,6 +45,8 @@ struct _Py_global_objects { _PyGC_Head_UNUSED _tuple_empty_gc_not_used; PyTupleObject tuple_empty; } singletons; + + PyObject *interned; }; diff --git a/Objects/unicodeobject.c b/Objects/unicodeobject.c index b1d14a32f70..13f2c5b49bd 100644 --- a/Objects/unicodeobject.c +++ b/Objects/unicodeobject.c @@ -191,16 +191,6 @@ extern "C" { # define OVERALLOCATE_FACTOR 4 #endif -/* This dictionary holds all interned unicode strings. Note that references - to strings in this dictionary are *not* counted in the string's ob_refcnt. - When the interned string reaches a refcnt of 0 the string deallocation - function will delete the reference from this dictionary. - - Another way to look at this is that to say that the actual reference - count of a string is: s->ob_refcnt + (s->state ? 2 : 0) -*/ -static PyObject *interned = NULL; - /* Forward declaration */ static inline int _PyUnicodeWriter_WriteCharInline(_PyUnicodeWriter *writer, Py_UCS4 ch); @@ -235,6 +225,23 @@ static inline PyObject* unicode_new_empty(void) return empty; } +/* This dictionary holds all interned unicode strings. Note that references + to strings in this dictionary are *not* counted in the string's ob_refcnt. + When the interned string reaches a refcnt of 0 the string deallocation + function will delete the reference from this dictionary. + Another way to look at this is that to say that the actual reference + count of a string is: s->ob_refcnt + (s->state ? 2 : 0) +*/ +static inline PyObject *get_interned_dict(void) +{ + return _PyRuntime.global_objects.interned; +} + +static inline void set_interned_dict(PyObject *dict) +{ + _PyRuntime.global_objects.interned = dict; +} + #define _Py_RETURN_UNICODE_EMPTY() \ do { \ return unicode_new_empty(); \ @@ -1523,7 +1530,7 @@ unicode_dealloc(PyObject *unicode) _Py_FatalRefcountError("deallocating an Unicode singleton"); } #endif - + PyObject *interned = get_interned_dict(); if (PyUnicode_CHECK_INTERNED(unicode)) { /* Revive the dead object temporarily. PyDict_DelItem() removes two references (key and value) which were ignored by @@ -14657,12 +14664,14 @@ PyUnicode_InternInPlace(PyObject **p) return; } + PyObject *interned = get_interned_dict(); if (interned == NULL) { interned = PyDict_New(); if (interned == NULL) { PyErr_Clear(); /* Don't leave an exception */ return; } + set_interned_dict(interned); } PyObject *t = PyDict_SetDefault(interned, s, s); @@ -14713,6 +14722,7 @@ _PyUnicode_ClearInterned(PyInterpreterState *interp) return; } + PyObject *interned = get_interned_dict(); if (interned == NULL) { return; } @@ -14748,7 +14758,8 @@ _PyUnicode_ClearInterned(PyInterpreterState *interp) #endif PyDict_Clear(interned); - Py_CLEAR(interned); + Py_DECREF(interned); + set_interned_dict(NULL); } @@ -15155,7 +15166,7 @@ _PyUnicode_EnableLegacyWindowsFSEncoding(void) static inline int unicode_is_finalizing(void) { - return (interned == NULL); + return (get_interned_dict() == NULL); } #endif @@ -15197,7 +15208,7 @@ _PyUnicode_Fini(PyInterpreterState *interp) if (_Py_IsMainInterpreter(interp)) { // _PyUnicode_ClearInterned() must be called before _PyUnicode_Fini() - assert(interned == NULL); + assert(get_interned_dict() == NULL); // bpo-47182: force a unicodedata CAPI capsule re-import on // subsequent initialization of main interpreter. ucnhash_capi = NULL;

1 0

GH-96071: add regression test for #96071 (GH-96137)
by miss-islington Aug. 22, 2022

Aug. 22, 2022

https://github.com/python/cpython/commit/079baee1962ff7c1f4b60f4dd4c803535e… commit: 079baee1962ff7c1f4b60f4dd4c803535ecbd18e branch: main author: Kumar Aditya <59607654+kumaraditya303(a)users.noreply.github.com> committer: miss-islington <31488909+miss-islington(a)users.noreply.github.com> date: 2022-08-22T11:40:23-07:00 summary: GH-96071: add regression test for #96071 (GH-96137) Automerge-Triggered-By: GH:ericsnowcurrently files: M Lib/test/test_capi.py diff --git a/Lib/test/test_capi.py b/Lib/test/test_capi.py index b698e34dec4..d0c4811cad1 100644 --- a/Lib/test/test_capi.py +++ b/Lib/test/test_capi.py @@ -1053,6 +1053,21 @@ def callback(): t.start() t.join() + @threading_helper.reap_threads + @threading_helper.requires_working_threading() + def test_gilstate_ensure_no_deadlock(self): + # See https://github.com/python/cpython/issues/96071 + code = textwrap.dedent(f""" + import _testcapi + + def callback(): + print('callback called') + + _testcapi._test_thread_state(callback) + """) + ret = assert_python_ok('-X', 'tracemalloc', '-c', code) + self.assertIn(b'callback called', ret.out) + class Test_testcapi(unittest.TestCase): locals().update((name, getattr(_testcapi, name))

1 0

gh-96076: Change test_launcher to use non-admin location for py.ini (GH-96091)
by miss-islington Aug. 22, 2022

Aug. 22, 2022

https://github.com/python/cpython/commit/4f7f83b5bdd61f01a5ad49fb4df61cab36… commit: 4f7f83b5bdd61f01a5ad49fb4df61cab3607ab99 branch: 3.11 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: miss-islington <31488909+miss-islington(a)users.noreply.github.com> date: 2022-08-22T09:49:34-07:00 summary: gh-96076: Change test_launcher to use non-admin location for py.ini (GH-96091) Patch authored by Eryksun. (cherry picked from commit 216ccacda193733ef92146c8ac1eb81893b4478d) Co-authored-by: Terry Jan Reedy <tjreedy(a)udel.edu> files: M Lib/test/test_launcher.py diff --git a/Lib/test/test_launcher.py b/Lib/test/test_launcher.py index 4ff84773727..8ef1f5df8b4 100644 --- a/Lib/test/test_launcher.py +++ b/Lib/test/test_launcher.py @@ -239,9 +239,11 @@ def run_py(self, args, env=None, allow_fail=False, expect_returncode=0, argv=Non return data def py_ini(self, content): - if not self.py_exe: - self.py_exe = self.find_py() - return PreservePyIni(self.py_exe.with_name("py.ini"), content) + local_appdata = os.environ.get("LOCALAPPDATA") + if not local_appdata: + raise unittest.SkipTest("LOCALAPPDATA environment variable is " + "missing or empty") + return PreservePyIni(Path(local_appdata) / "py.ini", content) @contextlib.contextmanager def script(self, content, encoding="utf-8"):

1 0

gh-96076: Change test_launcher to use non-admin location for py.ini (GH-96091)
by zooba Aug. 22, 2022

Aug. 22, 2022

https://github.com/python/cpython/commit/216ccacda193733ef92146c8ac1eb81893… commit: 216ccacda193733ef92146c8ac1eb81893b4478d branch: main author: Terry Jan Reedy <tjreedy(a)udel.edu> committer: zooba <steve.dower(a)microsoft.com> date: 2022-08-22T17:23:27+01:00 summary: gh-96076: Change test_launcher to use non-admin location for py.ini (GH-96091) Patch authored by Eryksun. files: M Lib/test/test_launcher.py diff --git a/Lib/test/test_launcher.py b/Lib/test/test_launcher.py index 835a51e3b6e..9e265901b18 100644 --- a/Lib/test/test_launcher.py +++ b/Lib/test/test_launcher.py @@ -238,9 +238,11 @@ def run_py(self, args, env=None, allow_fail=False, expect_returncode=0, argv=Non return data def py_ini(self, content): - if not self.py_exe: - self.py_exe = self.find_py() - return PreservePyIni(self.py_exe.with_name("py.ini"), content) + local_appdata = os.environ.get("LOCALAPPDATA") + if not local_appdata: + raise unittest.SkipTest("LOCALAPPDATA environment variable is " + "missing or empty") + return PreservePyIni(Path(local_appdata) / "py.ini", content) @contextlib.contextmanager def script(self, content, encoding="utf-8"):

1 0

gh-96046: Initialize ht_cached_keys in PyType_Ready() (GH-96047)
by miss-islington Aug. 22, 2022

Aug. 22, 2022

https://github.com/python/cpython/commit/3ea0beb3599f734bb9387a526dccd5768a… commit: 3ea0beb3599f734bb9387a526dccd5768ad6b1a9 branch: 3.11 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: miss-islington <31488909+miss-islington(a)users.noreply.github.com> date: 2022-08-22T02:12:42-07:00 summary: gh-96046: Initialize ht_cached_keys in PyType_Ready() (GH-96047) (cherry picked from commit 53e6a9a7254bdcd0538580ba7d799cd453e2dca5) Co-authored-by: Christian Heimes <christian(a)python.org> files: A Misc/NEWS.d/next/Core and Builtins/2022-08-18-13-47-59.gh-issue-96046.5Hqbka.rst M Objects/typeobject.c diff --git a/Misc/NEWS.d/next/Core and Builtins/2022-08-18-13-47-59.gh-issue-96046.5Hqbka.rst b/Misc/NEWS.d/next/Core and Builtins/2022-08-18-13-47-59.gh-issue-96046.5Hqbka.rst new file mode 100644 index 000000000000..b8cb52d4b4ec --- /dev/null +++ b/Misc/NEWS.d/next/Core and Builtins/2022-08-18-13-47-59.gh-issue-96046.5Hqbka.rst @@ -0,0 +1,4 @@ +:c:func:`PyType_Ready` now initializes ``ht_cached_keys`` and performs +additional checks to ensure that type objects are properly configured. This +avoids crashes in 3rd party packages that don't use regular API to create +new types. diff --git a/Objects/typeobject.c b/Objects/typeobject.c index 03cc72e742b2..9ee57105204e 100644 --- a/Objects/typeobject.c +++ b/Objects/typeobject.c @@ -3202,11 +3202,6 @@ type_new_impl(type_new_ctx *ctx) // Put the proper slots in place fixup_slot_dispatchers(type); - if (type->tp_flags & Py_TPFLAGS_MANAGED_DICT) { - PyHeapTypeObject *et = (PyHeapTypeObject*)type; - et->ht_cached_keys = _PyDict_NewKeysForClass(); - } - if (type_new_set_names(type) < 0) { goto error; } @@ -3588,10 +3583,6 @@ PyType_FromModuleAndSpec(PyObject *module, PyType_Spec *spec, PyObject *bases) if (PyType_Ready(type) < 0) goto fail; - if (type->tp_flags & Py_TPFLAGS_MANAGED_DICT) { - res->ht_cached_keys = _PyDict_NewKeysForClass(); - } - if (type->tp_doc) { PyObject *__doc__ = PyUnicode_FromString(_PyType_DocWithoutSignature(type->tp_name, type->tp_doc)); if (!__doc__) @@ -6409,6 +6400,29 @@ type_ready_set_new(PyTypeObject *type) return 0; } +static int +type_ready_managed_dict(PyTypeObject *type) +{ + if (!(type->tp_flags & Py_TPFLAGS_MANAGED_DICT)) { + return 0; + } + if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) { + PyErr_Format(PyExc_SystemError, + "type %s has the Py_TPFLAGS_MANAGED_DICT flag " + "but not Py_TPFLAGS_HEAPTYPE flag", + type->tp_name); + return -1; + } + PyHeapTypeObject* et = (PyHeapTypeObject*)type; + if (et->ht_cached_keys == NULL) { + et->ht_cached_keys = _PyDict_NewKeysForClass(); + if (et->ht_cached_keys == NULL) { + PyErr_NoMemory(); + return -1; + } + } + return 0; +} static int type_ready_post_checks(PyTypeObject *type) @@ -6469,6 +6483,9 @@ type_ready(PyTypeObject *type) if (type_ready_add_subclasses(type) < 0) { return -1; } + if (type_ready_managed_dict(type) < 0) { + return -1; + } if (type_ready_post_checks(type) < 0) { return -1; }

1 0

gh-96121: Merge sqlite3.Row examples into sqlite3.Row class doc (GH-96122)
by miss-islington Aug. 22, 2022

Aug. 22, 2022

https://github.com/python/cpython/commit/98622fa00e0f9d6c20ddb1ff62534e5aa2… commit: 98622fa00e0f9d6c20ddb1ff62534e5aa2f16e25 branch: 3.11 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: miss-islington <31488909+miss-islington(a)users.noreply.github.com> date: 2022-08-22T01:12:02-07:00 summary: gh-96121: Merge sqlite3.Row examples into sqlite3.Row class doc (GH-96122) Co-authored-by: Ezio Melotti <ezio.melotti(a)gmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach(a)Gerlach.CAM> (cherry picked from commit 18b1782192f85bd26db89f5bc850f8bee4247c1a) Co-authored-by: Erlend E. Aasland <erlend.aasland(a)innova.no> files: D Doc/includes/sqlite3/rowclass.py M Doc/library/sqlite3.rst diff --git a/Doc/includes/sqlite3/rowclass.py b/Doc/includes/sqlite3/rowclass.py deleted file mode 100644 index fc60287069a8..000000000000 --- a/Doc/includes/sqlite3/rowclass.py +++ /dev/null @@ -1,14 +0,0 @@ -import sqlite3 - -con = sqlite3.connect(":memory:") -con.row_factory = sqlite3.Row - -cur = con.cursor() -cur.execute("select 'John' as name, 42 as age") -for row in cur: - assert row[0] == row["name"] - assert row["name"] == row["nAmE"] - assert row[1] == row["age"] - assert row[1] == row["AgE"] - -con.close() diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst index 20ad760ac4b4..9805a42d2f59 100644 --- a/Doc/library/sqlite3.rst +++ b/Doc/library/sqlite3.rst @@ -207,7 +207,6 @@ inserted data and retrieved values from it in multiple ways. * :ref:`sqlite3-placeholders` * :ref:`sqlite3-adapters` * :ref:`sqlite3-converters` - * :ref:`sqlite3-columns-by-name` * :ref:`sqlite3-connection-context-manager` * :ref:`sqlite3-explanation` for in-depth background on transaction control. @@ -1242,6 +1241,11 @@ Cursor objects >>> cur.connection == con True +.. The sqlite3.Row example used to be a how-to. It has now been incorporated + into the Row reference. We keep the anchor here in order not to break + existing links. + +.. _sqlite3-columns-by-name: .. _sqlite3-row-objects: Row objects @@ -1249,10 +1253,9 @@ Row objects .. class:: Row - A :class:`Row` instance serves as a highly optimized + A :class:`!Row` instance serves as a highly optimized :attr:`~Connection.row_factory` for :class:`Connection` objects. - It tries to mimic a :class:`tuple` in most of its features, - and supports iteration, :func:`repr`, equality testing, :func:`len`, + It supports iteration, equality testing, :func:`len`, and :term:`mapping` access by column name and index. Two row objects compare equal if have equal columns and equal members. @@ -1266,45 +1269,18 @@ Row objects .. versionchanged:: 3.5 Added support of slicing. -Let's assume we initialize a table as in the example given above:: + Example:: - con = sqlite3.connect(":memory:") - cur = con.cursor() - cur.execute('''create table stocks - (date text, trans text, symbol text, - qty real, price real)''') - cur.execute("""insert into stocks - values ('2006-01-05','BUY','RHAT',100,35.14)""") - con.commit() - cur.close() - -Now we plug :class:`Row` in:: - - >>> con.row_factory = sqlite3.Row - >>> cur = con.cursor() - >>> cur.execute('select * from stocks') - <sqlite3.Cursor object at 0x7f4e7dd8fa80> - >>> r = cur.fetchone() - >>> type(r) - <class 'sqlite3.Row'> - >>> tuple(r) - ('2006-01-05', 'BUY', 'RHAT', 100.0, 35.14) - >>> len(r) - 5 - >>> r[2] - 'RHAT' - >>> r.keys() - ['date', 'trans', 'symbol', 'qty', 'price'] - >>> r['qty'] - 100.0 - >>> for member in r: - ... print(member) - ... - 2006-01-05 - BUY - RHAT - 100.0 - 35.14 + >>> con = sqlite3.connect(":memory:") + >>> con.row_factory = sqlite3.Row + >>> res = con.execute("SELECT 'Earth' AS name, 6378 AS radius") + >>> row = res.fetchone() + >>> row.keys() + ['name', 'radius'] + >>> row[0], row["name"] # Access by index and name. + ('Earth', 'Earth') + >>> row["RADIUS"] # Column names are case-insensitive. + 6378 .. _sqlite3-blob-objects: @@ -1726,20 +1702,6 @@ directly using only a single call on the :class:`Connection` object. .. literalinclude:: ../includes/sqlite3/shortcut_methods.py -.. _sqlite3-columns-by-name: - -Accessing columns by name instead of by index -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -One useful feature of the :mod:`!sqlite3` module is the built-in -:class:`sqlite3.Row` class designed to be used as a row factory. - -Rows wrapped with this class can be accessed both by index (like tuples) and -case-insensitively by name: - -.. literalinclude:: ../includes/sqlite3/rowclass.py - - .. _sqlite3-connection-context-manager: Using the connection as a context manager

1 0

gh-96121: Merge sqlite3.Row examples into sqlite3.Row class doc (GH-96122)
by miss-islington Aug. 22, 2022

Aug. 22, 2022

https://github.com/python/cpython/commit/a836204777dad55c983efba58e654a62a7… commit: a836204777dad55c983efba58e654a62a7bfdf61 branch: 3.10 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: miss-islington <31488909+miss-islington(a)users.noreply.github.com> date: 2022-08-22T01:10:53-07:00 summary: gh-96121: Merge sqlite3.Row examples into sqlite3.Row class doc (GH-96122) Co-authored-by: Ezio Melotti <ezio.melotti(a)gmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach(a)Gerlach.CAM> (cherry picked from commit 18b1782192f85bd26db89f5bc850f8bee4247c1a) Co-authored-by: Erlend E. Aasland <erlend.aasland(a)innova.no> files: D Doc/includes/sqlite3/rowclass.py M Doc/library/sqlite3.rst diff --git a/Doc/includes/sqlite3/rowclass.py b/Doc/includes/sqlite3/rowclass.py deleted file mode 100644 index fc60287069a8..000000000000 --- a/Doc/includes/sqlite3/rowclass.py +++ /dev/null @@ -1,14 +0,0 @@ -import sqlite3 - -con = sqlite3.connect(":memory:") -con.row_factory = sqlite3.Row - -cur = con.cursor() -cur.execute("select 'John' as name, 42 as age") -for row in cur: - assert row[0] == row["name"] - assert row["name"] == row["nAmE"] - assert row[1] == row["age"] - assert row[1] == row["AgE"] - -con.close() diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst index d01c7b554e9c..1f7ebbe109ff 100644 --- a/Doc/library/sqlite3.rst +++ b/Doc/library/sqlite3.rst @@ -207,7 +207,6 @@ inserted data and retrieved values from it in multiple ways. * :ref:`sqlite3-placeholders` * :ref:`sqlite3-adapters` * :ref:`sqlite3-converters` - * :ref:`sqlite3-columns-by-name` * :ref:`sqlite3-connection-context-manager` * :ref:`sqlite3-explanation` for in-depth background on transaction control. @@ -1017,6 +1016,11 @@ Cursor objects >>> cur.connection == con True +.. The sqlite3.Row example used to be a how-to. It has now been incorporated + into the Row reference. We keep the anchor here in order not to break + existing links. + +.. _sqlite3-columns-by-name: .. _sqlite3-row-objects: Row objects @@ -1024,10 +1028,9 @@ Row objects .. class:: Row - A :class:`Row` instance serves as a highly optimized + A :class:`!Row` instance serves as a highly optimized :attr:`~Connection.row_factory` for :class:`Connection` objects. - It tries to mimic a :class:`tuple` in most of its features, - and supports iteration, :func:`repr`, equality testing, :func:`len`, + It supports iteration, equality testing, :func:`len`, and :term:`mapping` access by column name and index. Two row objects compare equal if have equal columns and equal members. @@ -1041,45 +1044,18 @@ Row objects .. versionchanged:: 3.5 Added support of slicing. -Let's assume we initialize a table as in the example given above:: + Example:: - con = sqlite3.connect(":memory:") - cur = con.cursor() - cur.execute('''create table stocks - (date text, trans text, symbol text, - qty real, price real)''') - cur.execute("""insert into stocks - values ('2006-01-05','BUY','RHAT',100,35.14)""") - con.commit() - cur.close() - -Now we plug :class:`Row` in:: - - >>> con.row_factory = sqlite3.Row - >>> cur = con.cursor() - >>> cur.execute('select * from stocks') - <sqlite3.Cursor object at 0x7f4e7dd8fa80> - >>> r = cur.fetchone() - >>> type(r) - <class 'sqlite3.Row'> - >>> tuple(r) - ('2006-01-05', 'BUY', 'RHAT', 100.0, 35.14) - >>> len(r) - 5 - >>> r[2] - 'RHAT' - >>> r.keys() - ['date', 'trans', 'symbol', 'qty', 'price'] - >>> r['qty'] - 100.0 - >>> for member in r: - ... print(member) - ... - 2006-01-05 - BUY - RHAT - 100.0 - 35.14 + >>> con = sqlite3.connect(":memory:") + >>> con.row_factory = sqlite3.Row + >>> res = con.execute("SELECT 'Earth' AS name, 6378 AS radius") + >>> row = res.fetchone() + >>> row.keys() + ['name', 'radius'] + >>> row[0], row["name"] # Access by index and name. + ('Earth', 'Earth') + >>> row["RADIUS"] # Column names are case-insensitive. + 6378 PrepareProtocol objects @@ -1429,20 +1405,6 @@ directly using only a single call on the :class:`Connection` object. .. literalinclude:: ../includes/sqlite3/shortcut_methods.py -.. _sqlite3-columns-by-name: - -Accessing columns by name instead of by index -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -One useful feature of the :mod:`!sqlite3` module is the built-in -:class:`sqlite3.Row` class designed to be used as a row factory. - -Rows wrapped with this class can be accessed both by index (like tuples) and -case-insensitively by name: - -.. literalinclude:: ../includes/sqlite3/rowclass.py - - .. _sqlite3-connection-context-manager: Using the connection as a context manager

1 0