Skip to content

gh-69093: Add mapping protocol support to sqlite3.Blob #91599

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

Merged
JelleZijlstra merged 10 commits into from
Apr 22, 2022
Merged

gh-69093: Add mapping protocol support to sqlite3.Blob #91599

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
38b2cdb
gh-69093: Add mapping protocol support to sqlite3.Blob
Apr 16, 2022
8bc5762
Merge branch 'main' into sqlite-blob-add-mapping-protocol
Apr 16, 2022
86e324a
Cast
Apr 16, 2022
37a5c38
Assert lenght and offset
Apr 16, 2022
a179749
Accept all buffer objects
Apr 16, 2022
ed6a9b6
Address review: reword docs and modify example
Apr 18, 2022
233f940
bugfix: use correct offset in inner read/write
Apr 18, 2022
9cbc339
Update Misc/NEWS.d/next/Library/2022-04-14-01-00-31.gh-issue-69093.bm…
Apr 19, 2022
7df4b9d
Address review: verify writes
Apr 19, 2022
cb2619e
Address review: Py_ssize_t iso. int
Apr 19, 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
Prev Previous commit
Next Next commit
Merge branch 'main' into sqlite-blob-add-mapping-protocol
  • Loading branch information
Erlend E. Aasland committed Apr 16, 2022
commit 8bc57623142c984e6ce939734220c063023f755b
59 changes: 4 additions & 55 deletions Doc/library/sqlite3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1054,9 +1054,10 @@ Blob Objects

.. class:: Blob

A :class:`Blob` instance is a :term:`file-like object` that can read and write
data in an SQLite :abbr:`BLOB (Binary Large OBject)`. Call ``len(blob)`` to
get the size (number of bytes) of the blob.
A :class:`Blob` instance is a :term:`file-like object` with
:term:`mapping` support,
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
that can read and write data in an SQLite :abbr:`BLOB (Binary Large OBject)`.
Call ``len(blob)`` to get the size (number of bytes) of the blob.

Use the :class:`Blob` as a :term:`context manager` to ensure that the blob
handle is closed after use.
Expand Down Expand Up @@ -1158,58 +1159,6 @@ Exceptions

.. _sqlite3-blob-objects:

Blob Objects
------------

.. versionadded:: 3.11

.. class:: Blob

A :class:`Blob` instance is a :term:`file-like object` with
:term:`mapping` support,
that can read and write data in an SQLite :abbr:`BLOB (Binary Large OBject)`.
Call ``len(blob)`` to get the size (number of bytes) of the blob.

Use the :class:`Blob` as a :term:`context manager` to ensure that the blob
handle is closed after use.

.. literalinclude:: ../includes/sqlite3/blob.py

.. method:: close()

Close the blob.

The blob will be unusable from this point onward. An
:class:`~sqlite3.Error` (or subclass) exception will be raised if any
further operation is attempted with the blob.

.. method:: read(length=-1, /)

Read *length* bytes of data from the blob at the current offset position.
If the end of the blob is reached, the data up to
:abbr:`EOF (End of File)` will be returned. When *length* is not
specified, or is negative, :meth:`~Blob.read` will read until the end of
the blob.

.. method:: write(data, /)

Write *data* to the blob at the current offset. This function cannot
change the blob length. Writing beyond the end of the blob will raise
:exc:`ValueError`.

.. method:: tell()

Return the current access position of the blob.

.. method:: seek(offset, origin=os.SEEK_SET, /)

Set the current access position of the blob to *offset*. The *origin*
argument defaults to :data:`os.SEEK_SET` (absolute blob positioning).
Other values for *origin* are :data:`os.SEEK_CUR` (seek relative to the
current position) and :data:`os.SEEK_END` (seek relative to the blob’s
end).


.. _sqlite3-types:

SQLite and Python types
Expand Down
You are viewing a condensed version of this merge commit. You can view the full changes here.