Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

gh-94321: Document sqlite3.PrepareProtocol #94620

Merged
merged 5 commits into from
Jul 7, 2022
Merged

gh-94321: Document sqlite3.PrepareProtocol #94620

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7ad6f24
gh-94321: Document sqlite3.PrepareProtocol
erlend-aasland Jul 6, 2022
d5b6ee8
Adjust class docstr
erlend-aasland Jul 6, 2022
a594f27
Fix syntax
erlend-aasland Jul 6, 2022
e20fd19
Address CAM's review
erlend-aasland Jul 7, 2022
cc04744
Add missing heading
erlend-aasland Jul 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions Doc/library/sqlite3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1140,6 +1140,13 @@ Blob Objects
end).


.. 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
Expand Down Expand Up @@ -1298,6 +1305,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
""""""""""""""""""""""""""""""""

Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Documentation/2022-07-07-08-42-05.gh-issue-94321.pmCIPb.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Document the :pep:`246` style protocol type
:class:`sqlite3.PrepareProtocol`.
3 changes: 3 additions & 0 deletions Modules/_sqlite/prepare_protocol.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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},
};

Expand Down