FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-156939: Document that PyASCIIObject ends with null byte by vstinner · Pull Request #157708 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-156939: Document that PyASCIIObject ends with null byte #157708

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
vstinner merged 2 commits into from
Sep 19, 2026
+28 −3
Conversation 2 Commits 2 Checks 29 Files changed 1
Merged

gh-156939: Document that PyASCIIObject ends with null byte #157708

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee34138
gh-156939: Document that PyASCIIObject ends with null byte
vstinner Sep 17, 2026
eef4c0c
Rephrase
vstinner Sep 19, 2026
File filter

Filter by extension

Filter by extension .rst  (1) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
31 changes: 28 additions & 3 deletions Doc/c-api/unicode.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ points must be below 1114112 (which is the full Unicode range).

UTF-8 representation is created on demand and cached in the Unicode object.

.. impl-detail::

The internal buffer always includes an extra trailing null character for
compatibility with null terminated C strings. This extra character is not
counted in :c:func:`PyUnicode_GetLength` nor in the various *size* arguments
of the functions below.

.. note::
The :c:type:`Py_UNICODE` representation has been removed since Python 3.12
with deprecated APIs.
Expand Down Expand Up @@ -164,11 +171,15 @@ access to internal read-only data of Unicode objects:
.. versionadded:: 3.3


.. c:function:: Py_UCS4 PyUnicode_READ(int kind, void *data, \
Py_ssize_t index)
.. c:function:: Py_UCS4 PyUnicode_READ(int kind, void *data, Py_ssize_t index)

Read a code point from a canonical representation *data* (as obtained with
:c:func:`PyUnicode_DATA`). No checks or ready calls are performed.
:c:func:`PyUnicode_DATA`). No checks are performed.

.. impl-detail::

Accept reading the trailing null character at index
:c:func:`PyUnicode_GetLength`.

.. versionadded:: 3.3

Expand All @@ -179,6 +190,11 @@ access to internal read-only data of Unicode objects:
representation. This is less efficient than :c:func:`PyUnicode_READ` if you
do multiple consecutive reads.

.. impl-detail::

Accept reading the trailing null character at index
:c:func:`PyUnicode_GetLength`.

.. versionadded:: 3.3


Expand Down Expand Up @@ -716,6 +732,10 @@ APIs:

On error, set an exception and return ``-1``.

.. impl-detail::

The length does not count the trailing null character.

.. versionadded:: 3.3


Expand Down Expand Up @@ -794,6 +814,11 @@ APIs:

Return character on success, ``-1`` on error with an exception set.

.. impl-detail::

Do not accept reading the trailing null character at index
:c:func:`PyUnicode_GetLength`.

.. versionadded:: 3.3


Expand Down
Loading
Back | FazBrowse Home | New Git URL