Skip to content

bpo-39560: Document PyUnicode_FromKindAndData() kind transformation #23848

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
nanjekyejoannah merged 1 commit into from
Jun 3, 2021
Merged

bpo-39560: Document PyUnicode_FromKindAndData() kind transformation #23848

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions Doc/c-api/unicode.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -422,6 +422,12 @@ APIs:
:c:func:`PyUnicode_KIND`). The *buffer* must point to an array of *size*
units of 1, 2 or 4 bytes per character, as given by the kind.

If necessary, the input *buffer* is copied and transformed into the
canonical representation. For example, if the *buffer* is a UCS4 string
(:c:macro:`PyUnicode_4BYTE_KIND`) and it consists only of codepoints in
the UCS1 range, it will be transformed into UCS1
(:c:macro:`PyUnicode_1BYTE_KIND`).

.. versionadded:: 3.3


Expand Down