diff options
| author | Erlend Egeberg Aasland <erlend.aasland@protonmail.com> | 2022-07-07 22:33:17 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-07 22:33:17 (GMT) |
| commit | fb6dccae348b954d9f625031b54711a9a33da525 (patch) | |
| tree | 8a953d31c6919041a05261a38941353c33b4e5a0 | |
| parent | 71697664d71e09dcf34aac41f6c100350efc3726 (diff) | |
| download | cpython-fb6dccae348b954d9f625031b54711a9a33da525.zip cpython-fb6dccae348b954d9f625031b54711a9a33da525.tar.gz cpython-fb6dccae348b954d9f625031b54711a9a33da525.tar.bz2 | |
gh-94321: Document sqlite3.PrepareProtocol (#94620)
| -rw-r--r-- | Doc/library/sqlite3.rst | 12 | ||||
| -rw-r--r-- | Misc/NEWS.d/next/Documentation/2022-07-07-08-42-05.gh-issue-94321.pmCIPb.rst | 2 | ||||
| -rw-r--r-- | Modules/_sqlite/prepare_protocol.c | 3 |
3 files changed, 17 insertions, 0 deletions
diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst index ad49a21..2f4e2ae 100644 --- a/Doc/library/sqlite3.rst +++ b/Doc/library/sqlite3.rst @@ -1139,6 +1139,16 @@ Blob Objects end). +PrepareProtocol Objects +----------------------- + +.. class:: PrepareProtocol + + The PrepareProtocol type's single purpose is to act as a :pep:`246` style + adaption protocol for objects that can :ref:`adapt themselves + <sqlite3-conform>` to :ref:`native SQLite types <sqlite3-types>`. + + .. _sqlite3-exceptions: Exceptions @@ -1297,6 +1307,8 @@ As an application developer, it may make more sense to take direct control by registering custom adapter functions. +.. _sqlite3-conform: + Letting your object adapt itself """""""""""""""""""""""""""""""" diff --git a/Misc/NEWS.d/next/Documentation/2022-07-07-08-42-05.gh-issue-94321.pmCIPb.rst b/Misc/NEWS.d/next/Documentation/2022-07-07-08-42-05.gh-issue-94321.pmCIPb.rst new file mode 100644 index 0000000..c1a8dcd --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2022-07-07-08-42-05.gh-issue-94321.pmCIPb.rst @@ -0,0 +1,2 @@ +Document the :pep:`246` style protocol type +:class:`sqlite3.PrepareProtocol`. diff --git a/Modules/_sqlite/prepare_protocol.c b/Modules/_sqlite/prepare_protocol.c index cefb46e..4453322 100644 --- a/Modules/_sqlite/prepare_protocol.c +++ b/Modules/_sqlite/prepare_protocol.c @@ -46,10 +46,13 @@ pysqlite_prepare_protocol_dealloc(pysqlite_PrepareProtocol *self) Py_DECREF(tp); } +PyDoc_STRVAR(doc, "PEP 246 style object adaption protocol type."); + static PyType_Slot type_slots[] = { {Py_tp_dealloc, pysqlite_prepare_protocol_dealloc}, {Py_tp_init, pysqlite_prepare_protocol_init}, {Py_tp_traverse, pysqlite_prepare_protocol_traverse}, + {Py_tp_doc, (void *)doc}, {0, NULL}, }; |