From ab174fb5388e3abec505fa56524773256892e8c4 Mon Sep 17 00:00:00 2001 From: "Erlend E. Aasland" Date: Tue, 8 Mar 2022 10:56:46 +0100 Subject: [PATCH 1/3] Docstring: replace pysqlite with sqlite3 Replace two instances of "pysqlite" with "sqlite3" in sqlite3 docstrings. Also reword the same docstring with "does nothing" to "is a no-op" to align them with the docs. --- Modules/_sqlite/clinic/cursor.c.h | 6 +++--- Modules/_sqlite/cursor.c | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Modules/_sqlite/clinic/cursor.c.h b/Modules/_sqlite/clinic/cursor.c.h index a8de7f216b2bbf..6ecbc7aab2b02e 100644 --- a/Modules/_sqlite/clinic/cursor.c.h +++ b/Modules/_sqlite/clinic/cursor.c.h @@ -232,7 +232,7 @@ PyDoc_STRVAR(pysqlite_cursor_setinputsizes__doc__, "setinputsizes($self, sizes, /)\n" "--\n" "\n" -"Required by DB-API. Does nothing in pysqlite."); +"Required by DB-API. Is a no-op in sqlite3."); #define PYSQLITE_CURSOR_SETINPUTSIZES_METHODDEF \ {"setinputsizes", (PyCFunction)pysqlite_cursor_setinputsizes, METH_O, pysqlite_cursor_setinputsizes__doc__}, @@ -241,7 +241,7 @@ PyDoc_STRVAR(pysqlite_cursor_setoutputsize__doc__, "setoutputsize($self, size, column=None, /)\n" "--\n" "\n" -"Required by DB-API. Does nothing in pysqlite."); +"Required by DB-API. Is a no-op in sqlite3."); #define PYSQLITE_CURSOR_SETOUTPUTSIZE_METHODDEF \ {"setoutputsize", (PyCFunction)(void(*)(void))pysqlite_cursor_setoutputsize, METH_FASTCALL, pysqlite_cursor_setoutputsize__doc__}, @@ -289,4 +289,4 @@ pysqlite_cursor_close(pysqlite_Cursor *self, PyObject *Py_UNUSED(ignored)) { return pysqlite_cursor_close_impl(self); } -/*[clinic end generated code: output=ab1375c060ff7021 input=a9049054013a1b77]*/ +/*[clinic end generated code: output=9b1fa0a9ed487d0d input=a9049054013a1b77]*/ diff --git a/Modules/_sqlite/cursor.c b/Modules/_sqlite/cursor.c index c8e68218642e85..e0639a9fae728e 100644 --- a/Modules/_sqlite/cursor.c +++ b/Modules/_sqlite/cursor.c @@ -921,12 +921,12 @@ _sqlite3.Cursor.setinputsizes as pysqlite_cursor_setinputsizes sizes: object / -Required by DB-API. Does nothing in pysqlite. +Required by DB-API. Is a no-op in sqlite3. [clinic start generated code]*/ static PyObject * pysqlite_cursor_setinputsizes(pysqlite_Cursor *self, PyObject *sizes) -/*[clinic end generated code: output=893c817afe9d08ad input=7cffbb168663bc69]*/ +/*[clinic end generated code: output=893c817afe9d08ad input=fb94819915c45e78]*/ { Py_RETURN_NONE; } @@ -938,13 +938,13 @@ _sqlite3.Cursor.setoutputsize as pysqlite_cursor_setoutputsize column: object = None / -Required by DB-API. Does nothing in pysqlite. +Required by DB-API. Is a no-op in sqlite3. [clinic start generated code]*/ static PyObject * pysqlite_cursor_setoutputsize_impl(pysqlite_Cursor *self, PyObject *size, PyObject *column) -/*[clinic end generated code: output=018d7e9129d45efe input=077b017da58b9389]*/ +/*[clinic end generated code: output=018d7e9129d45efe input=ba9cf4b3647463f8]*/ { Py_RETURN_NONE; } From 24b3f6e37e20e03c1fcc59eecffd14bde4d0e4a8 Mon Sep 17 00:00:00 2001 From: "Erlend E. Aasland" Date: Tue, 8 Mar 2022 20:41:24 +0100 Subject: [PATCH 2/3] Address review: make no-op change a no-op --- Modules/_sqlite/clinic/cursor.c.h | 6 +++--- Modules/_sqlite/cursor.c | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Modules/_sqlite/clinic/cursor.c.h b/Modules/_sqlite/clinic/cursor.c.h index 6ecbc7aab2b02e..03bdbb766e9659 100644 --- a/Modules/_sqlite/clinic/cursor.c.h +++ b/Modules/_sqlite/clinic/cursor.c.h @@ -232,7 +232,7 @@ PyDoc_STRVAR(pysqlite_cursor_setinputsizes__doc__, "setinputsizes($self, sizes, /)\n" "--\n" "\n" -"Required by DB-API. Is a no-op in sqlite3."); +"Required by DB-API. Does nothing in sqlite3."); #define PYSQLITE_CURSOR_SETINPUTSIZES_METHODDEF \ {"setinputsizes", (PyCFunction)pysqlite_cursor_setinputsizes, METH_O, pysqlite_cursor_setinputsizes__doc__}, @@ -241,7 +241,7 @@ PyDoc_STRVAR(pysqlite_cursor_setoutputsize__doc__, "setoutputsize($self, size, column=None, /)\n" "--\n" "\n" -"Required by DB-API. Is a no-op in sqlite3."); +"Required by DB-API. Does nothing in sqlite3."); #define PYSQLITE_CURSOR_SETOUTPUTSIZE_METHODDEF \ {"setoutputsize", (PyCFunction)(void(*)(void))pysqlite_cursor_setoutputsize, METH_FASTCALL, pysqlite_cursor_setoutputsize__doc__}, @@ -289,4 +289,4 @@ pysqlite_cursor_close(pysqlite_Cursor *self, PyObject *Py_UNUSED(ignored)) { return pysqlite_cursor_close_impl(self); } -/*[clinic end generated code: output=9b1fa0a9ed487d0d input=a9049054013a1b77]*/ +/*[clinic end generated code: output=1bee279bc861f6d3 input=a9049054013a1b77]*/ diff --git a/Modules/_sqlite/cursor.c b/Modules/_sqlite/cursor.c index e0639a9fae728e..69beccd0f09dcd 100644 --- a/Modules/_sqlite/cursor.c +++ b/Modules/_sqlite/cursor.c @@ -921,12 +921,12 @@ _sqlite3.Cursor.setinputsizes as pysqlite_cursor_setinputsizes sizes: object / -Required by DB-API. Is a no-op in sqlite3. +Required by DB-API. Does nothing in sqlite3. [clinic start generated code]*/ static PyObject * pysqlite_cursor_setinputsizes(pysqlite_Cursor *self, PyObject *sizes) -/*[clinic end generated code: output=893c817afe9d08ad input=fb94819915c45e78]*/ +/*[clinic end generated code: output=893c817afe9d08ad input=de7950a3aec79bdf]*/ { Py_RETURN_NONE; } @@ -938,13 +938,13 @@ _sqlite3.Cursor.setoutputsize as pysqlite_cursor_setoutputsize column: object = None / -Required by DB-API. Is a no-op in sqlite3. +Required by DB-API. Does nothing in sqlite3. [clinic start generated code]*/ static PyObject * pysqlite_cursor_setoutputsize_impl(pysqlite_Cursor *self, PyObject *size, PyObject *column) -/*[clinic end generated code: output=018d7e9129d45efe input=ba9cf4b3647463f8]*/ +/*[clinic end generated code: output=018d7e9129d45efe input=607a6bece8bbb273]*/ { Py_RETURN_NONE; } From 345b2e489ed471fde1ca18167b36cc6d128d347b Mon Sep 17 00:00:00 2001 From: "Erlend E. Aasland" Date: Tue, 8 Mar 2022 20:44:09 +0100 Subject: [PATCH 3/3] Align docs with docstrings --- Doc/library/sqlite3.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst index d213933ba5827f..c456905bc956cc 100644 --- a/Doc/library/sqlite3.rst +++ b/Doc/library/sqlite3.rst @@ -836,11 +836,11 @@ Cursor Objects .. method:: setinputsizes(sizes) - Required by the DB-API. Is a no-op in :mod:`sqlite3`. + Required by the DB-API. Does nothing in :mod:`sqlite3`. .. method:: setoutputsize(size [, column]) - Required by the DB-API. Is a no-op in :mod:`sqlite3`. + Required by the DB-API. Does nothing in :mod:`sqlite3`. .. attribute:: rowcount