Об’єкти та кодеки Unicode

Об’єкти Unicode

З моменту впровадження PEP 393 у Python 3.3 об’єкти Unicode внутрішньо використовують різноманітні представлення, щоб дозволити обробку повного діапазону символів Unicode, залишаючись ефективним для пам’яті. Існують особливі випадки для рядків, де всі кодові точки нижчі за 128, 256 або 65536; інакше кодові точки повинні бути нижче 1114112 (що є повним діапазоном Unicode).

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

Примітка

The Py_UNICODE representation has been removed since Python 3.12 with deprecated APIs. See PEP 623 for more information.

Тип Unicode

Ось основні типи об’єктів Unicode, які використовуються для реалізації Unicode в Python:

PyTypeObject PyUnicode_Type

Part of the Stable ABI.

This instance of PyTypeObject represents the Python Unicode type. It is exposed to Python code as str.

PyTypeObject PyUnicodeIter_Type

Part of the Stable ABI.

This instance of PyTypeObject represents the Python Unicode iterator type. It is used to iterate over Unicode string objects.

type Py_UCS4

type Py_UCS2

type Py_UCS1

Part of the Stable ABI.

Ці типи є визначеннями типів для беззнакових цілих типів, достатньо широких, щоб містити символи 32 біти, 16 бітів і 8 бітів відповідно. При роботі з окремими символами Unicode використовуйте Py_UCS4.

Added in version 3.3.

type PyASCIIObject

type PyCompactUnicodeObject

type PyUnicodeObject

Ці підтипи PyObject представляють об’єкт Python Unicode. Майже у всіх випадках їх не слід використовувати напряму, оскільки всі функції API, які працюють з об’єктами Unicode, приймають і повертають покажчики PyObject.

Added in version 3.3.

The following APIs are C macros and static inlined functions for fast checks and access to internal read-only data of Unicode objects:

int PyUnicode_Check(PyObject *obj)

Return true if the object obj is a Unicode object or an instance of a Unicode subtype. This function always succeeds.

int PyUnicode_CheckExact(PyObject *obj)

Return true if the object obj is a Unicode object, but not an instance of a subtype. This function always succeeds.

Py_ssize_t PyUnicode_GET_LENGTH(PyObject *unicode)

Return the length of the Unicode string, in code points. unicode has to be a Unicode object in the «canonical» representation (not checked).

Added in version 3.3.

Py_UCS1 *PyUnicode_1BYTE_DATA(PyObject *unicode)

Py_UCS2 *PyUnicode_2BYTE_DATA(PyObject *unicode)

Py_UCS4 *PyUnicode_4BYTE_DATA(PyObject *unicode)

Return a pointer to the canonical representation cast to UCS1, UCS2 or UCS4 integer types for direct character access. No checks are performed if the canonical representation has the correct character size; use PyUnicode_KIND() to select the right function.

Added in version 3.3.

PyUnicode_1BYTE_KIND

PyUnicode_2BYTE_KIND

PyUnicode_4BYTE_KIND

Повертає значення макросу PyUnicode_KIND().

Added in version 3.3.

Змінено в версії 3.12: PyUnicode_WCHAR_KIND has been removed.

int PyUnicode_KIND(PyObject *unicode)

Return one of the PyUnicode kind constants (see above) that indicate how many bytes per character this Unicode object uses to store its data. unicode has to be a Unicode object in the «canonical» representation (not checked).

Added in version 3.3.

void *PyUnicode_DATA(PyObject *unicode)

Return a void pointer to the raw Unicode buffer. unicode has to be a Unicode object in the «canonical» representation (not checked).

Added in version 3.3.

void PyUnicode_WRITE(int kind, void *data, Py_ssize_t index, Py_UCS4 value)

Write the code point value to the given zero-based index in a string.

The kind value and data pointer must have been obtained from a string using PyUnicode_KIND() and PyUnicode_DATA() respectively. You must hold a reference to that string while calling PyUnicode_WRITE(). All requirements of PyUnicode_WriteChar() also apply.

The function performs no checks for any of its requirements, and is intended for usage in loops.

Added in version 3.3.

Py_UCS4 PyUnicode_READ(int kind, void *data, Py_ssize_t index)

Прочитайте кодову точку з канонічного представлення data (отриманого за допомогою PyUnicode_DATA()). Перевірки чи готові виклики не виконуються.

Added in version 3.3.

Py_UCS4 PyUnicode_READ_CHAR(PyObject *unicode, Py_ssize_t index)

Read a character from a Unicode object unicode, which must be in the «canonical» representation. This is less efficient than PyUnicode_READ() if you do multiple consecutive reads.

Added in version 3.3.

Py_UCS4 PyUnicode_MAX_CHAR_VALUE(PyObject *unicode)

Return the maximum code point that is suitable for creating another string based on unicode, which must be in the «canonical» representation. This is always an approximation but more efficient than iterating over the string.

Added in version 3.3.

int PyUnicode_IsIdentifier(PyObject *unicode)

Part of the Stable ABI.

Повертає 1, якщо рядок є дійсним ідентифікатором відповідно до визначення мови, розділ Names (identifiers and keywords). Інакше поверніть 0.

Змінено в версії 3.9: Функція більше не викликає Py_FatalError(), якщо рядок не готовий.

unsigned int PyUnicode_IS_ASCII(PyObject *unicode)

Return true if the string only contains ASCII characters. Equivalent to str.isascii().

Added in version 3.2.

Py_hash_t PyUnstable_Unicode_GET_CACHED_HASH(PyObject *str)

This is Unstable API. It may change without warning in minor releases.

If the hash of str, as returned by PyObject_Hash(), has been cached and is immediately available, return it. Otherwise, return -1 without setting an exception.

If str is not a string (that is, if PyUnicode_Check(obj) is false), the behavior is undefined.

This function never fails with an exception.

Note that there are no guarantees on when an object’s hash is cached, and the (non-)existence of a cached hash does not imply that the string has any other properties.

Властивості символів Unicode

Unicode надає багато різних властивостей символів. Найпотрібніші з них доступні через ці макроси, які зіставляються з функціями C залежно від конфігурації Python.

int Py_UNICODE_ISSPACE(Py_UCS4 ch)

Повертає «1» або «0» залежно від того, чи ch є пробілом.

int Py_UNICODE_ISLOWER(Py_UCS4 ch)

Повертає «1» або «0» залежно від того, чи ch є символом нижнього регістру.

int Py_UNICODE_ISUPPER(Py_UCS4 ch)

Повертає 1 або 0 залежно від того, чи ch є символом у верхньому регістрі.

int Py_UNICODE_ISTITLE(Py_UCS4 ch)

Повертає 1 або 0 залежно від того, чи ch є символом заголовка.

int Py_UNICODE_ISLINEBREAK(Py_UCS4 ch)

Повертає «1» або «0» залежно від того, чи є ch символом розриву рядка.

int Py_UNICODE_ISDECIMAL(Py_UCS4 ch)

Повертає «1» або «0» залежно від того, чи є ch десятковим символом.

int Py_UNICODE_ISDIGIT(Py_UCS4 ch)

Повертає «1» або «0» залежно від того, чи є ch символом цифри.

int Py_UNICODE_ISNUMERIC(Py_UCS4 ch)

Повертає «1» або «0» залежно від того, чи є ch цифровим символом.

int Py_UNICODE_ISALPHA(Py_UCS4 ch)

Повертає «1» або «0» залежно від того, чи ch є буквою.

int Py_UNICODE_ISALNUM(Py_UCS4 ch)

Повертає «1» або «0» залежно від того, чи є ch буквено-цифровим символом.

int Py_UNICODE_ISPRINTABLE(Py_UCS4 ch)

Return 1 or 0 depending on whether ch is a printable character, in the sense of str.isprintable().

Ці API можна використовувати для швидкого прямого перетворення символів:

Py_UCS4 Py_UNICODE_TOLOWER(Py_UCS4 ch)

Повертає символ ch, перетворений на нижній регістр.

Py_UCS4 Py_UNICODE_TOUPPER(Py_UCS4 ch)

Повертає символ ch, перетворений у верхній регістр.

Py_UCS4 Py_UNICODE_TOTITLE(Py_UCS4 ch)

Повертає символ ch, перетворений на регістр заголовка.

int Py_UNICODE_TODECIMAL(Py_UCS4 ch)

Return the character ch converted to a decimal positive integer. Return -1 if this is not possible. This function does not raise exceptions.

int Py_UNICODE_TODIGIT(Py_UCS4 ch)

Return the character ch converted to a single digit integer. Return -1 if this is not possible. This function does not raise exceptions.

double Py_UNICODE_TONUMERIC(Py_UCS4 ch)

Return the character ch converted to a double. Return -1.0 if this is not possible. This function does not raise exceptions.

Ці API можна використовувати для роботи із сурогатами:

int Py_UNICODE_IS_SURROGATE(Py_UCS4 ch)

Перевірте, чи ch є сурогатом (0xD800 <= ch <= 0xDFFF).

int Py_UNICODE_IS_HIGH_SURROGATE(Py_UCS4 ch)

Перевірте, чи ch є високим сурогатом (0xD800 <= ch <= 0xDBFF).

int Py_UNICODE_IS_LOW_SURROGATE(Py_UCS4 ch)

Перевірте, чи ch є низьким сурогатом (0xDC00 <= ch <= 0xDFFF).

Py_UCS4 Py_UNICODE_JOIN_SURROGATES(Py_UCS4 high, Py_UCS4 low)

Join two surrogate code points and return a single Py_UCS4 value. high and low are respectively the leading and trailing surrogates in a surrogate pair. high must be in the range [0xD800; 0xDBFF] and low must be in the range [0xDC00; 0xDFFF].

Створення та доступ до рядків Unicode

Щоб створити об’єкти Unicode та отримати доступ до їхніх основних властивостей послідовності, використовуйте ці API:

PyObject *PyUnicode_New(Py_ssize_t size, Py_UCS4 maxchar)

Return value: New reference.

Створіть новий об’єкт Unicode. maxchar має бути справжньою максимальною кодовою точкою, яка буде розміщена в рядку. Приблизно його можна округлити до найближчого значення в послідовності 127, 255, 65535, 1114111.

On error, set an exception and return NULL.

After creation, the string can be filled by PyUnicode_WriteChar(), PyUnicode_CopyCharacters(), PyUnicode_Fill(), PyUnicode_WRITE() or similar. Since strings are supposed to be immutable, take care to not “use” the result while it is being modified. In particular, before it’s filled with its final contents, a string:

• must not be hashed,

• must not be converted to UTF-8, or another non-«canonical» representation,

• must not have its reference count changed,

• must not be shared with code that might do one of the above.

This list is not exhaustive. Avoiding these uses is your responsibility; Python does not always check these requirements.

To avoid accidentally exposing a partially-written string object, prefer using the PyUnicodeWriter API, or one of the PyUnicode_From* functions below.

Added in version 3.3.

PyObject *PyUnicode_FromKindAndData(int kind, const void *buffer, Py_ssize_t size)

Return value: New reference.

Створіть новий об’єкт Unicode із заданим kind (можливі значення: PyUnicode_1BYTE_KIND тощо, як повертає PyUnicode_KIND()). Буфер має вказувати на масив одиниць розміру по 1, 2 або 4 байти на символ, як задано типом.

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

Added in version 3.3.

PyObject *PyUnicode_FromStringAndSize(const char *str, Py_ssize_t size)

Return value: New reference. Part of the Stable ABI.

Create a Unicode object from the char buffer str. The bytes will be interpreted as being UTF-8 encoded. The buffer is copied into the new object. The return value might be a shared object, i.e. modification of the data is not allowed.

This function raises SystemError when:

• size < 0,

• str is NULL and size > 0

Змінено в версії 3.12: str == NULL with size > 0 is not allowed anymore.

PyObject *PyUnicode_FromString(const char *str)

Return value: New reference. Part of the Stable ABI.

Create a Unicode object from a UTF-8 encoded null-terminated char buffer str.

PyObject *PyUnicode_FromFormat(const char *format, ...)

Return value: New reference. Part of the Stable ABI.

Take a C printf()-style format string and a variable number of arguments, calculate the size of the resulting Python Unicode string and return a string with the values formatted into it. The variable arguments must be C types and must correspond exactly to the format characters in the format ASCII-encoded string.

Специфікатор перетворення містить два або більше символів і має наступні компоненти, які мають відображатися в такому порядку:

1. Символ '%', який позначає початок специфікатора.

2. Прапорці перетворення (опціонально), які впливають на результат деяких типів перетворення.

3. Minimum field width (optional). If specified as an '*' (asterisk), the actual width is given in the next argument, which must be of type int, and the object to convert comes after the minimum field width and optional precision.

4. Precision (optional), given as a '.' (dot) followed by the precision. If specified as '*' (an asterisk), the actual precision is given in the next argument, which must be of type int, and the value to convert comes after the precision.

5. Модифікатор довжини (необов’язково).

6. Тип перетворення.

Символи прапора перетворення:

Прапор	Значення
0	Перетворення буде доповнено нулем для числових значень.
-	The converted value is left adjusted (overrides the 0 flag if both are given).

The length modifiers for following integer conversions (d, i, o, u, x, or X) specify the type of the argument (int by default):

Modifier	Типи
l	long or unsigned long
ll	long long or unsigned long long
j	intmax_t or uintmax_t
z	size_t or ssize_t
t	ptrdiff_t

The length modifier l for following conversions s or V specify that the type of the argument is const wchar_t*.

The conversion specifiers are:

Conversion Specifier	Тип	коментар
%	немає	The literal % character.
d, i	Specified by the length modifier	The decimal representation of a signed C integer.
u	Specified by the length modifier	The decimal representation of an unsigned C integer.
о	Specified by the length modifier	The octal representation of an unsigned C integer.
x	Specified by the length modifier	The hexadecimal representation of an unsigned C integer (lowercase).
X	Specified by the length modifier	The hexadecimal representation of an unsigned C integer (uppercase).
c	int	A single character.
s	const char* or const wchar_t*	Масив символів C із закінченням нулем.
p	const void*	The hex representation of a C pointer. Mostly equivalent to printf("%p") except that it is guaranteed to start with the literal 0x regardless of what the platform’s printf yields.
A	PyObject*	Результат виклику ascii().
U	PyObject*	Об’єкт Unicode.
V	PyObject*, const char* or const wchar_t*	Об’єкт Unicode (який може бути NULL) і масив символів C із нульовим закінченням як другий параметр (який використовуватиметься, якщо перший параметр NULL).
S	PyObject*	Результат виклику PyObject_Str().
R	PyObject*	Результат виклику PyObject_Repr().
T	PyObject*	Get the fully qualified name of an object type; call PyType_GetFullyQualifiedName().
#T	PyObject*	Similar to T format, but use a colon (:) as separator between the module name and the qualified name.
N	PyTypeObject*	Get the fully qualified name of a type; call PyType_GetFullyQualifiedName().
#N	PyTypeObject*	Similar to N format, but use a colon (:) as separator between the module name and the qualified name.

Примітка

The width formatter unit is number of characters rather than bytes. The precision formatter unit is number of bytes or wchar_t items (if the length modifier l is used) for "%s" and "%V" (if the PyObject* argument is NULL), and a number of characters for "%A", "%U", "%S", "%R" and "%V" (if the PyObject* argument is not NULL).

Примітка

Unlike to C printf() the 0 flag has effect even when a precision is given for integer conversions (d, i, u, o, x, or X).

Змінено в версії 3.2: Додано підтримку "%lld" і "%llu".

Змінено в версії 3.3: Додано підтримку "%li", "%lli" і "%zi".

Змінено в версії 3.4: Підтримка ширини та точного форматування для "%s", "%A", "%U", "%V", "%S", "%R" додано.

Змінено в версії 3.12: Support for conversion specifiers o and X. Support for length modifiers j and t. Length modifiers are now applied to all integer conversions. Length modifier l is now applied to conversion specifiers s and V. Support for variable width and precision *. Support for flag -.

An unrecognized format character now sets a SystemError. In previous versions it caused all the rest of the format string to be copied as-is to the result string, and any extra arguments discarded.

Змінено в версії 3.13: Support for %T, %#T, %N and %#N formats added.

PyObject *PyUnicode_FromFormatV(const char *format, va_list vargs)

Return value: New reference. Part of the Stable ABI.

Ідентичний PyUnicode_FromFormat() за винятком того, що він приймає рівно два аргументи.

PyObject *PyUnicode_FromObject(PyObject *obj)

Return value: New reference. Part of the Stable ABI.

Copy an instance of a Unicode subtype to a new true Unicode object if necessary. If obj is already a true Unicode object (not a subtype), return a new strong reference to the object.

Об’єкти, відмінні від Unicode або його підтипів, викличуть TypeError.

PyObject *PyUnicode_FromOrdinal(int ordinal)

Return value: New reference. Part of the Stable ABI.

Create a Unicode Object from the given Unicode code point ordinal.

The ordinal must be in range(0x110000). A ValueError is raised in the case it is not.

PyObject *PyUnicode_FromEncodedObject(PyObject *obj, const char *encoding, const char *errors)

Return value: New reference. Part of the Stable ABI.

Декодуйте закодований об’єкт obj в об’єкт Unicode.

bytes, bytearray та інші bytes-подібні об’єкти декодуються відповідно до заданого кодування та з використанням обробки помилок, визначеної errors. Обидва можуть бути NULL, щоб інтерфейс використовував значення за замовчуванням (дивіться Вбудовані кодеки для деталей).

Усі інші об’єкти, включно з об’єктами Unicode, викликають встановлення TypeError.

API повертає NULL, якщо сталася помилка. Виклик відповідає за декодування повернутих об’єктів.

void PyUnicode_Append(PyObject **p_left, PyObject *right)

Part of the Stable ABI.

Append the string right to the end of p_left. p_left must point to a strong reference to a Unicode object; PyUnicode_Append() releases («steals») this reference.

On error, set *p_left to NULL and set an exception.

On success, set *p_left to a new strong reference to the result.

void PyUnicode_AppendAndDel(PyObject **p_left, PyObject *right)

Part of the Stable ABI.

The function is similar to PyUnicode_Append(), with the only difference being that it decrements the reference count of right by one.

PyObject *PyUnicode_BuildEncodingMap(PyObject *string)

Return value: New reference. Part of the Stable ABI.

Return a mapping suitable for decoding a custom single-byte encoding. Given a Unicode string string of up to 256 characters representing an encoding table, returns either a compact internal mapping object or a dictionary mapping character ordinals to byte values. Raises a TypeError and return NULL on invalid input.

Added in version 3.2.

const char *PyUnicode_GetDefaultEncoding(void)

Part of the Stable ABI.

Return the name of the default string encoding, "utf-8". See sys.getdefaultencoding().

The returned string does not need to be freed, and is valid until interpreter shutdown.

Py_ssize_t PyUnicode_GetLength(PyObject *unicode)

Part of the Stable ABI since version 3.7.

Повертає довжину об’єкта Юнікод у кодових точках.

On error, set an exception and return -1.

Added in version 3.3.

Py_ssize_t PyUnicode_CopyCharacters(PyObject *to, Py_ssize_t to_start, PyObject *from, Py_ssize_t from_start, Py_ssize_t how_many)

Copy characters from one Unicode object into another. This function performs character conversion when necessary and falls back to memcpy() if possible. Returns -1 and sets an exception on error, otherwise returns the number of copied characters.

The string must not have been “used” yet. See PyUnicode_New() for details.

Added in version 3.3.

int PyUnicode_Resize(PyObject **unicode, Py_ssize_t length);

Part of the Stable ABI.

Resize a Unicode object *unicode to the new length in code points.

Try to resize the string in place (which is usually faster than allocating a new string and copying characters), or create a new string.

*unicode is modified to point to the new (resized) object and 0 is returned on success. Otherwise, -1 is returned and an exception is set, and *unicode is left untouched.

The function doesn’t check string content, the result may not be a string in canonical representation.

Py_ssize_t PyUnicode_Fill(PyObject *unicode, Py_ssize_t start, Py_ssize_t length, Py_UCS4 fill_char)

Заповніть рядок символом: напишіть fill_char у unicode[start:start+length].

Помилка, якщо fill_char перевищує максимальний символ рядка або якщо рядок має більше ніж 1 посилання.

The string must not have been “used” yet. See PyUnicode_New() for details.

Повертає номер написаного символу або повертає -1 і викликає виняток у разі помилки.

Added in version 3.3.

int PyUnicode_WriteChar(PyObject *unicode, Py_ssize_t index, Py_UCS4 character)

Part of the Stable ABI since version 3.7.

Write a character to the string unicode at the zero-based index. Return 0 on success, -1 on error with an exception set.

This function checks that unicode is a Unicode object, that the index is not out of bounds, and that the object’s reference count is one). See PyUnicode_WRITE() for a version that skips these checks, making them your responsibility.

The string must not have been “used” yet. See PyUnicode_New() for details.

Added in version 3.3.

Py_UCS4 PyUnicode_ReadChar(PyObject *unicode, Py_ssize_t index)

Part of the Stable ABI since version 3.7.

Read a character from a string. This function checks that unicode is a Unicode object and the index is not out of bounds, in contrast to PyUnicode_READ_CHAR(), which performs no error checking.

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

Added in version 3.3.

PyObject *PyUnicode_Substring(PyObject *unicode, Py_ssize_t start, Py_ssize_t end)

Return value: New reference. Part of the Stable ABI since version 3.7.

Return a substring of unicode, from character index start (included) to character index end (excluded). Negative indices are not supported. On error, set an exception and return NULL.

Added in version 3.3.

Py_UCS4 *PyUnicode_AsUCS4(PyObject *unicode, Py_UCS4 *buffer, Py_ssize_t buflen, int copy_null)

Part of the Stable ABI since version 3.7.

Copy the string unicode into a UCS4 buffer, including a null character, if copy_null is set. Returns NULL and sets an exception on error (in particular, a SystemError if buflen is smaller than the length of unicode). buffer is returned on success.

Added in version 3.3.

Py_UCS4 *PyUnicode_AsUCS4Copy(PyObject *unicode)

Part of the Stable ABI since version 3.7.

Copy the string unicode into a new UCS4 buffer that is allocated using PyMem_Malloc(). If this fails, NULL is returned with a MemoryError set. The returned buffer always has an extra null code point appended.

Added in version 3.3.

Кодування мови

Поточне кодування мови можна використовувати для декодування тексту з операційної системи.

PyObject *PyUnicode_DecodeLocaleAndSize(const char *str, Py_ssize_t length, const char *errors)

Return value: New reference. Part of the Stable ABI since version 3.7.

Декодуйте рядок з UTF-8 на Android і VxWorks або з поточного кодування мови на інших платформах. Підтримуваними обробниками помилок є "strict" і "surrogateescape" (PEP 383). Декодер використовує "strict" обробник помилок, якщо errors має значення NULL. str має закінчуватися нульовим символом, але не може містити вбудовані нульові символи.

Use PyUnicode_DecodeFSDefaultAndSize() to decode a string from the filesystem encoding and error handler.

Ця функція ігнорує Режим Python UTF-8.

Дивись також

Функція Py_DecodeLocale().

Added in version 3.3.

Змінено в версії 3.7: Функція тепер також використовує поточне кодування мови для обробника помилок surrogateescape, за винятком Android. Раніше Py_DecodeLocale() використовувався для surrogateescape, а поточне кодування мови використовувалося для strict.

PyObject *PyUnicode_DecodeLocale(const char *str, const char *errors)

Return value: New reference. Part of the Stable ABI since version 3.7.

Similar to PyUnicode_DecodeLocaleAndSize(), but compute the string length using strlen().

Added in version 3.3.

PyObject *PyUnicode_EncodeLocale(PyObject *unicode, const char *errors)

Return value: New reference. Part of the Stable ABI since version 3.7.

Закодуйте об’єкт Unicode до UTF-8 на Android і VxWorks або до поточного кодування мови на інших платформах. Підтримуваними обробниками помилок є "strict" і "surrogateescape" (PEP 383). Кодер використовує "strict" обробник помилок, якщо errors має значення NULL. Повертає об’єкт bytes. unicode не може містити вбудовані нульові символи.

Use PyUnicode_EncodeFSDefault() to encode a string to the filesystem encoding and error handler.

Ця функція ігнорує Режим Python UTF-8.

Дивись також

Функція Py_EncodeLocale().

Added in version 3.3.

Змінено в версії 3.7: Функція тепер також використовує поточне кодування мови для обробника помилок surrogateescape, за винятком Android. Раніше Py_EncodeLocale() використовувався для surrogateescape, а поточне кодування мови використовувалося для strict.

Кодування файлової системи

Functions encoding to and decoding from the filesystem encoding and error handler (PEP 383 and PEP 529).

To encode file names to bytes during argument parsing, the "O&" converter should be used, passing PyUnicode_FSConverter() as the conversion function:

int PyUnicode_FSConverter(PyObject *obj, void *result)

Part of the Stable ABI.

PyArg_Parse* converter: encode str objects – obtained directly or through the os.PathLike interface – to bytes using PyUnicode_EncodeFSDefault(); bytes objects are output as-is. result must be an address of a C variable of type PyObject* (or PyBytesObject*). On success, set the variable to a new strong reference to a bytes object which must be released when it is no longer used and return a non-zero value (Py_CLEANUP_SUPPORTED). Embedded null bytes are not allowed in the result. On failure, return 0 with an exception set.

If obj is NULL, the function releases a strong reference stored in the variable referred by result and returns 1.

Added in version 3.1.

Змінено в версії 3.6: Приймає path-like object.

To decode file names to str during argument parsing, the "O&" converter should be used, passing PyUnicode_FSDecoder() as the conversion function:

int PyUnicode_FSDecoder(PyObject *obj, void *result)

Part of the Stable ABI.

PyArg_Parse* converter: decode bytes objects – obtained either directly or indirectly through the os.PathLike interface – to str using PyUnicode_DecodeFSDefaultAndSize(); str objects are output as-is. result must be an address of a C variable of type PyObject* (or PyUnicodeObject*). On success, set the variable to a new strong reference to a Unicode object which must be released when it is no longer used and return a non-zero value (Py_CLEANUP_SUPPORTED). Embedded null characters are not allowed in the result. On failure, return 0 with an exception set.

If obj is NULL, release the strong reference to the object referred to by result and return 1.

Added in version 3.2.

Змінено в версії 3.6: Приймає path-like object.

PyObject *PyUnicode_DecodeFSDefaultAndSize(const char *str, Py_ssize_t size)

Return value: New reference. Part of the Stable ABI.

Декодуйте рядок із filesystem encoding and error handler.

If you need to decode a string from the current locale encoding, use PyUnicode_DecodeLocaleAndSize().

Дивись також

Функція Py_DecodeLocale().

Змінено в версії 3.6: The filesystem error handler is now used.

PyObject *PyUnicode_DecodeFSDefault(const char *str)

Return value: New reference. Part of the Stable ABI.

Декодуйте рядок із нульовим закінченням із filesystem encoding and error handler.

If the string length is known, use PyUnicode_DecodeFSDefaultAndSize().

Змінено в версії 3.6: The filesystem error handler is now used.

PyObject *PyUnicode_EncodeFSDefault(PyObject *unicode)

Return value: New reference. Part of the Stable ABI.

Encode a Unicode object to the filesystem encoding and error handler, and return bytes. Note that the resulting bytes object can contain null bytes.

If you need to encode a string to the current locale encoding, use PyUnicode_EncodeLocale().

Дивись також

Функція Py_EncodeLocale().

Added in version 3.2.

Змінено в версії 3.6: The filesystem error handler is now used.

Підтримка wchar_t

wchar_t підтримка платформ, які її підтримують:

PyObject *PyUnicode_FromWideChar(const wchar_t *wstr, Py_ssize_t size)

Return value: New reference. Part of the Stable ABI.

Create a Unicode object from the wchar_t buffer wstr of the given size. Passing -1 as the size indicates that the function must itself compute the length, using wcslen(). Return NULL on failure.

Py_ssize_t PyUnicode_AsWideChar(PyObject *unicode, wchar_t *wstr, Py_ssize_t size)

Part of the Stable ABI.

Copy the Unicode object contents into the wchar_t buffer wstr. At most size wchar_t characters are copied (excluding a possibly trailing null termination character). Return the number of wchar_t characters copied or -1 in case of an error.

When wstr is NULL, instead return the size that would be required to store all of unicode including a terminating null.

Note that the resulting wchar_t* string may or may not be null-terminated. It is the responsibility of the caller to make sure that the wchar_t* string is null-terminated in case this is required by the application. Also, note that the wchar_t* string might contain null characters, which would cause the string to be truncated when used with most C functions.

wchar_t *PyUnicode_AsWideCharString(PyObject *unicode, Py_ssize_t *size)

Part of the Stable ABI since version 3.7.

Convert the Unicode object to a wide character string. The output string always ends with a null character. If size is not NULL, write the number of wide characters (excluding the trailing null termination character) into *size. Note that the resulting wchar_t string might contain null characters, which would cause the string to be truncated when used with most C functions. If size is NULL and the wchar_t* string contains null characters a ValueError is raised.

Returns a buffer allocated by PyMem_New (use PyMem_Free() to free it) on success. On error, returns NULL and *size is undefined. Raises a MemoryError if memory allocation is failed.

Added in version 3.2.

Змінено в версії 3.7: Raises a ValueError if size is NULL and the wchar_t* string contains null characters.

Вбудовані кодеки

Python надає набір вбудованих кодеків, написаних на C для швидкості. Усі ці кодеки можна безпосередньо використовувати за допомогою наведених нижче функцій.

Багато з наведених нижче API приймають кодування двох аргументів і помилки, і вони мають таку саму семантику, як і вбудовані конструктори рядкових об’єктів str().

Setting encoding to NULL causes the default encoding to be used which is UTF-8. The file system calls should use PyUnicode_FSConverter() for encoding file names. This uses the filesystem encoding and error handler internally.

Обробка помилок встановлюється помилками, які також можуть мати значення NULL, що означає використання обробки за замовчуванням, визначеної для кодека. Обробка помилок за замовчуванням для всіх вбудованих кодеків є «суворою» (ValueError викликається).

Усі кодеки використовують подібний інтерфейс. Для простоти документуються лише відхилення від наступних загальних.

Загальні кодеки

The following macro is provided:

Py_UNICODE_REPLACEMENT_CHARACTER

The Unicode code point U+FFFD (replacement character).

This Unicode character is used as the replacement character during decoding if the errors argument is set to «replace».

Це загальні кодеки API:

PyObject *PyUnicode_Decode(const char *str, Py_ssize_t size, const char *encoding, const char *errors)

Return value: New reference. Part of the Stable ABI.

Create a Unicode object by decoding size bytes of the encoded string str. encoding and errors have the same meaning as the parameters of the same name in the str() built-in function. The codec to be used is looked up using the Python codec registry. Return NULL if an exception was raised by the codec.

PyObject *PyUnicode_AsEncodedString(PyObject *unicode, const char *encoding, const char *errors)

Return value: New reference. Part of the Stable ABI.

Закодуйте об’єкт Unicode та поверніть результат як об’єкт Python bytes. encoding і errors мають те саме значення, що й однойменні параметри в методі Unicode encode(). Кодек, який буде використовуватися, шукається за допомогою реєстру кодеків Python. Повертає NULL, якщо кодек викликав виняткову ситуацію.

Кодеки UTF-8

Це API кодека UTF-8:

PyObject *PyUnicode_DecodeUTF8(const char *str, Py_ssize_t size, const char *errors)

Return value: New reference. Part of the Stable ABI.

Create a Unicode object by decoding size bytes of the UTF-8 encoded string str. Return NULL if an exception was raised by the codec.

PyObject *PyUnicode_DecodeUTF8Stateful(const char *str, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)

Return value: New reference. Part of the Stable ABI.

Якщо consumed дорівнює NULL, поводьтеся як PyUnicode_DecodeUTF8(). Якщо consumed не має значення NULL, кінцеві неповні послідовності байтів UTF-8 не розглядатимуться як помилка. Ці байти не будуть декодовані, а кількість декодованих байтів зберігатиметься в спожитих.

PyObject *PyUnicode_AsUTF8String(PyObject *unicode)

Return value: New reference. Part of the Stable ABI.

Закодуйте об’єкт Unicode за допомогою UTF-8 і поверніть результат як об’єкт Python bytes. Обробка помилок «строга». Повертає NULL, якщо кодек викликав виняткову ситуацію.

The function fails if the string contains surrogate code points (U+D800 - U+DFFF).

const char *PyUnicode_AsUTF8AndSize(PyObject *unicode, Py_ssize_t *size)

Part of the Stable ABI since version 3.10.

Поверніть вказівник на кодування UTF-8 об’єкта Unicode та збережіть розмір закодованого представлення (у байтах) у size. Аргумент size може бути NULL; у цьому випадку розмір не буде збережено. До поверненого буфера завжди додається додатковий нульовий байт (не включений у size), незалежно від того, чи є інші нульові кодові точки.

On error, set an exception, set size to -1 (if it’s not NULL) and return NULL.

The function fails if the string contains surrogate code points (U+D800 - U+DFFF).

Це кешує представлення UTF-8 рядка в об’єкті Unicode, а наступні виклики повертатимуть вказівник на той самий буфер. Абонент не несе відповідальності за звільнення буфера. Буфер звільняється, і покажчики на нього стають недійсними, коли об’єкт Unicode збирається як сміття.

Added in version 3.3.

Змінено в версії 3.7: Тип повернення тепер const char *, а не char *.

Змінено в версії 3.10: This function is a part of the limited API.

const char *PyUnicode_AsUTF8(PyObject *unicode)

Як PyUnicode_AsUTF8AndSize(), але не зберігає розмір.

Попередження

This function does not have any special behavior for null characters embedded within unicode. As a result, strings containing null characters will remain in the returned string, which some C functions might interpret as the end of the string, leading to truncation. If truncation is an issue, it is recommended to use PyUnicode_AsUTF8AndSize() instead.

Added in version 3.3.

Змінено в версії 3.7: Тип повернення тепер const char *, а не char *.

Кодеки UTF-32

Це API кодеків UTF-32:

PyObject *PyUnicode_DecodeUTF32(const char *str, Py_ssize_t size, const char *errors, int *byteorder)

Return value: New reference. Part of the Stable ABI.

Декодуйте байти size із рядка буфера, закодованого в UTF-32, і повертайте відповідний об’єкт Unicode. errors (якщо не NULL) визначає обробку помилок. За замовчуванням встановлено «суворий».

Якщо byteorder не NULL, декодер починає декодування, використовуючи вказаний порядок байтів:

*byteorder == -1: little endian
*byteorder == 0:  native order
*byteorder == 1:  big endian

Якщо *byteorder дорівнює нулю, а перші чотири байти вхідних даних є міткою порядку байтів (BOM), декодер перемикається на цей порядок байтів і BOM не копіюється в результуючий рядок Unicode. Якщо *byteorder дорівнює -1 або 1, будь-яка позначка порядку байтів копіюється до виводу.

Після завершення *byteorder встановлюється на поточний порядок байтів у кінці вхідних даних.

Якщо byteorder дорівнює NULL, кодек запускається в режимі власного порядку.

Повертає NULL, якщо кодек викликав виняткову ситуацію.

PyObject *PyUnicode_DecodeUTF32Stateful(const char *str, Py_ssize_t size, const char *errors, int *byteorder, Py_ssize_t *consumed)

Return value: New reference. Part of the Stable ABI.

Якщо consumed дорівнює NULL, поводьтеся як PyUnicode_DecodeUTF32(). Якщо consumed не дорівнює NULL, PyUnicode_DecodeUTF32Stateful() не розглядатиме кінцеві неповні послідовності байтів UTF-32 (наприклад, кількість байтів, що не ділиться на чотири) як помилку. Ці байти не будуть декодовані, а кількість декодованих байтів зберігатиметься в спожитих.

PyObject *PyUnicode_AsUTF32String(PyObject *unicode)

Return value: New reference. Part of the Stable ABI.

Повертає байтовий рядок Python, використовуючи кодування UTF-32 у рідному порядку байтів. Рядок завжди починається з позначки BOM. Обробка помилок «строга». Повертає NULL, якщо кодек викликав виняткову ситуацію.

Кодеки UTF-16

Це API кодека UTF-16:

PyObject *PyUnicode_DecodeUTF16(const char *str, Py_ssize_t size, const char *errors, int *byteorder)

Return value: New reference. Part of the Stable ABI.

Декодуйте байти size із рядка буфера, закодованого в UTF-16, і повертайте відповідний об’єкт Unicode. errors (якщо не NULL) визначає обробку помилок. За замовчуванням встановлено «суворий».

Якщо byteorder не NULL, декодер починає декодування, використовуючи вказаний порядок байтів:

*byteorder == -1: little endian
*byteorder == 0:  native order
*byteorder == 1:  big endian

Якщо *byteorder дорівнює нулю, а перші два байти вхідних даних є міткою порядку байтів (BOM), декодер перемикається на цей порядок байтів і BOM не копіюється в результуючий рядок Unicode. Якщо *byteorder дорівнює -1 або 1, будь-яка позначка порядку байтів копіюється до виводу (де це призведе до \ufeff або \ufffe символ).

Після завершення *byteorder встановлюється на поточний порядок байтів у кінці вхідних даних.

Якщо byteorder дорівнює NULL, кодек запускається в режимі власного порядку.

Повертає NULL, якщо кодек викликав виняткову ситуацію.

PyObject *PyUnicode_DecodeUTF16Stateful(const char *str, Py_ssize_t size, const char *errors, int *byteorder, Py_ssize_t *consumed)

Return value: New reference. Part of the Stable ABI.

Якщо consumed дорівнює NULL, поводьтеся як PyUnicode_DecodeUTF16(). Якщо consumed не дорівнює NULL, PyUnicode_DecodeUTF16Stateful() не розглядатиме кінцеві неповні послідовності байтів UTF-16 (наприклад, непарну кількість байтів або розділену сурогатну пару) як помилку. Ці байти не будуть декодовані, а кількість декодованих байтів зберігатиметься в спожитих.

PyObject *PyUnicode_AsUTF16String(PyObject *unicode)

Return value: New reference. Part of the Stable ABI.

Повертає байтовий рядок Python, використовуючи кодування UTF-16 у рідному порядку байтів. Рядок завжди починається з позначки BOM. Обробка помилок «строга». Повертає NULL, якщо кодек викликав виняткову ситуацію.

Кодеки UTF-7

Це API кодека UTF-7:

PyObject *PyUnicode_DecodeUTF7(const char *str, Py_ssize_t size, const char *errors)

Return value: New reference. Part of the Stable ABI.

Create a Unicode object by decoding size bytes of the UTF-7 encoded string str. Return NULL if an exception was raised by the codec.

PyObject *PyUnicode_DecodeUTF7Stateful(const char *str, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)

Return value: New reference. Part of the Stable ABI.

Якщо consumed дорівнює NULL, поводьтеся як PyUnicode_DecodeUTF7(). Якщо consumed не дорівнює NULL, кінцеві неповні розділи UTF-7 base-64 не розглядатимуться як помилка. Ці байти не будуть декодовані, а кількість декодованих байтів зберігатиметься в спожитих.

Кодеки Unicode-Escape

Це API кодека «Unicode Escape»:

PyObject *PyUnicode_DecodeUnicodeEscape(const char *str, Py_ssize_t size, const char *errors)

Return value: New reference. Part of the Stable ABI.

Create a Unicode object by decoding size bytes of the Unicode-Escape encoded string str. Return NULL if an exception was raised by the codec.

PyObject *PyUnicode_AsUnicodeEscapeString(PyObject *unicode)

Return value: New reference. Part of the Stable ABI.

Закодуйте об’єкт Unicode за допомогою Unicode-Escape та поверніть результат як об’єкт bytes. Обробка помилок «строга». Повертає NULL, якщо кодек викликав виняткову ситуацію.

Кодеки Raw-Unicode-Escape

Це API кодека «Raw Unicode Escape»:

PyObject *PyUnicode_DecodeRawUnicodeEscape(const char *str, Py_ssize_t size, const char *errors)

Return value: New reference. Part of the Stable ABI.

Create a Unicode object by decoding size bytes of the Raw-Unicode-Escape encoded string str. Return NULL if an exception was raised by the codec.

PyObject *PyUnicode_AsRawUnicodeEscapeString(PyObject *unicode)

Return value: New reference. Part of the Stable ABI.

Закодуйте об’єкт Unicode за допомогою Raw-Unicode-Escape та поверніть результат як об’єкт bytes. Обробка помилок «строга». Повертає NULL, якщо кодек викликав виняткову ситуацію.

Кодеки Latin-1

Це API кодека Latin-1: Latin-1 відповідає першим 256 порядковим номерам Unicode, і лише вони приймаються кодеками під час кодування.

PyObject *PyUnicode_DecodeLatin1(const char *str, Py_ssize_t size, const char *errors)

Return value: New reference. Part of the Stable ABI.

Create a Unicode object by decoding size bytes of the Latin-1 encoded string str. Return NULL if an exception was raised by the codec.

PyObject *PyUnicode_AsLatin1String(PyObject *unicode)

Return value: New reference. Part of the Stable ABI.

Закодуйте об’єкт Unicode за допомогою Latin-1 і поверніть результат як об’єкт Python bytes. Обробка помилок «строга». Повертає NULL, якщо кодек викликав виняткову ситуацію.

Кодеки ASCII

Це API кодеків ASCII. Приймаються лише 7-бітні дані ASCII. Усі інші коди генерують помилки.

PyObject *PyUnicode_DecodeASCII(const char *str, Py_ssize_t size, const char *errors)

Return value: New reference. Part of the Stable ABI.

Create a Unicode object by decoding size bytes of the ASCII encoded string str. Return NULL if an exception was raised by the codec.

PyObject *PyUnicode_AsASCIIString(PyObject *unicode)

Return value: New reference. Part of the Stable ABI.

Закодуйте об’єкт Unicode за допомогою ASCII і поверніть результат як об’єкт Python bytes. Обробка помилок «строга». Повертає NULL, якщо кодек викликав виняткову ситуацію.

Кодеки карти символів

This codec is special in that it can be used to implement many different codecs (and this is in fact what was done to obtain most of the standard codecs included in the encodings package). The codec uses mappings to encode and decode characters. The mapping objects provided must support the __getitem__() mapping interface; dictionaries and sequences work well.

Це API кодека відображення:

PyObject *PyUnicode_DecodeCharmap(const char *str, Py_ssize_t length, PyObject *mapping, const char *errors)

Return value: New reference. Part of the Stable ABI.

Create a Unicode object by decoding size bytes of the encoded string str using the given mapping object. Return NULL if an exception was raised by the codec.

Якщо mapping має значення NULL, буде застосовано декодування Latin-1. Інакше відображення має зіставляти порядкові номери байтів (цілі числа в діапазоні від 0 до 255) на рядки Unicode, цілі числа (які потім інтерпретуються як порядкові номери Unicode) або None. Невідображені байти даних – ті, які викликають LookupError, а також ті, які відображаються на None, 0xFFFE або '\ufffe, розглядаються як невизначені відображення і викликати помилку.

PyObject *PyUnicode_AsCharmapString(PyObject *unicode, PyObject *mapping)

Return value: New reference. Part of the Stable ABI.

Закодуйте об’єкт Unicode за допомогою даного об’єкта mapping і поверніть результат як об’єкт bytes. Обробка помилок «строга». Повертає NULL, якщо кодек викликав виняткову ситуацію.

Об’єкт mapping має зіставляти порядкові цілі числа Unicode з об’єктами bytes, цілі числа в діапазоні від 0 до 255 або None. Невідображені порядкові символи (які спричиняють LookupError), а також відображені на None розглядаються як «невизначене відображення» та викликають помилку.

Наступний кодек API є особливим у тому, що відображає Unicode на Unicode.

PyObject *PyUnicode_Translate(PyObject *unicode, PyObject *table, const char *errors)

Return value: New reference. Part of the Stable ABI.

Перекладіть рядок, застосувавши до нього таблицю зіставлення символів і поверніть отриманий об’єкт Unicode. Повертає NULL, якщо кодек викликав виняткову ситуацію.

Таблиця відображення має зіставляти порядкові цілі числа Unicode з порядковими цілими числами Unicode або «Немає» (спричиняючи видалення символу).

Mapping tables need only provide the __getitem__() interface; dictionaries and sequences work well. Unmapped character ordinals (ones which cause a LookupError) are left untouched and are copied as-is.

помилки має звичайне значення для кодеків. Це може бути NULL, що вказує на використання стандартної обробки помилок.

Кодеки MBCS для Windows

Це API кодека MBCS. Наразі вони доступні лише у Windows і використовують конвертери Win32 MBCS для реалізації перетворень. Зауважте, що MBCS (або DBCS) — це клас кодувань, а не одне. Цільове кодування визначається налаштуваннями користувача на машині, на якій працює кодек.

PyObject *PyUnicode_DecodeMBCS(const char *str, Py_ssize_t size, const char *errors)

Return value: New reference. Part of the Stable ABI on Windows since version 3.7.

Create a Unicode object by decoding size bytes of the MBCS encoded string str. Return NULL if an exception was raised by the codec.

PyObject *PyUnicode_DecodeMBCSStateful(const char *str, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)

Return value: New reference. Part of the Stable ABI on Windows since version 3.7.

Якщо consumed дорівнює NULL, поводьтеся як PyUnicode_DecodeMBCS(). Якщо consumed не дорівнює NULL, PyUnicode_DecodeMBCSStateful() не декодуватиме кінцевий провідний байт, а кількість декодованих байтів зберігатиметься в consumed.

PyObject *PyUnicode_DecodeCodePageStateful(int code_page, const char *str, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)

Return value: New reference. Part of the Stable ABI on Windows since version 3.7.

Similar to PyUnicode_DecodeMBCSStateful(), except uses the code page specified by code_page.

PyObject *PyUnicode_AsMBCSString(PyObject *unicode)

Return value: New reference. Part of the Stable ABI on Windows since version 3.7.

Закодуйте об’єкт Unicode за допомогою MBCS і поверніть результат як об’єкт Python bytes. Обробка помилок «строга». Повертає NULL, якщо кодек викликав виняткову ситуацію.

PyObject *PyUnicode_EncodeCodePage(int code_page, PyObject *unicode, const char *errors)

Return value: New reference. Part of the Stable ABI on Windows since version 3.7.

Encode the Unicode object using the specified code page and return a Python bytes object. Return NULL if an exception was raised by the codec. Use CP_ACP code page to get the MBCS encoder.

Added in version 3.3.

Методи та функції слота

Наступні API здатні обробляти об’єкти Unicode та рядки на вхідних даних (ми називаємо їх рядками в описах) і повертати об’єкти Unicode або цілі числа відповідно.

Усі вони повертають NULL або -1, якщо виникає виняткова ситуація.

PyObject *PyUnicode_Concat(PyObject *left, PyObject *right)

Return value: New reference. Part of the Stable ABI.

Concat два рядки дають новий рядок Unicode.

PyObject *PyUnicode_Split(PyObject *unicode, PyObject *sep, Py_ssize_t maxsplit)

Return value: New reference. Part of the Stable ABI.

Розділити рядок, що дасть список рядків Unicode. Якщо sep дорівнює NULL, розділення буде виконано на всіх пробільних підрядках. В іншому випадку на даному сепараторі відбуваються розбивання. Буде виконано не більше ніж maxsplit. Якщо значення від’ємне, обмеження не встановлено. Розділювачі не включені в отриманий список.

On error, return NULL with an exception set.

Equivalent to str.split().

PyObject *PyUnicode_RSplit(PyObject *unicode, PyObject *sep, Py_ssize_t maxsplit)

Return value: New reference. Part of the Stable ABI.

Similar to PyUnicode_Split(), but splitting will be done beginning at the end of the string.

On error, return NULL with an exception set.

Equivalent to str.rsplit().

PyObject *PyUnicode_Splitlines(PyObject *unicode, int keepends)

Return value: New reference. Part of the Stable ABI.

Split a Unicode string at line breaks, returning a list of Unicode strings. CRLF is considered to be one line break. If keepends is 0, the Line break characters are not included in the resulting strings.

PyObject *PyUnicode_Partition(PyObject *unicode, PyObject *sep)

Return value: New reference. Part of the Stable ABI.

Split a Unicode string at the first occurrence of sep, and return a 3-tuple containing the part before the separator, the separator itself, and the part after the separator. If the separator is not found, return a 3-tuple containing the string itself, followed by two empty strings.

sep must not be empty.

On error, return NULL with an exception set.

Equivalent to str.partition().

PyObject *PyUnicode_RPartition(PyObject *unicode, PyObject *sep)

Return value: New reference. Part of the Stable ABI.

Similar to PyUnicode_Partition(), but split a Unicode string at the last occurrence of sep. If the separator is not found, return a 3-tuple containing two empty strings, followed by the string itself.

sep must not be empty.

On error, return NULL with an exception set.

Equivalent to str.rpartition().

PyObject *PyUnicode_Join(PyObject *separator, PyObject *seq)

Return value: New reference. Part of the Stable ABI.

З’єднайте послідовність рядків за допомогою заданого роздільника та поверніть отриманий рядок Unicode.

Py_ssize_t PyUnicode_Tailmatch(PyObject *unicode, PyObject *substr, Py_ssize_t start, Py_ssize_t end, int direction)

Part of the Stable ABI.

Return 1 if substr matches unicode[start:end] at the given tail end (direction == -1 means to do a prefix match, direction == 1 a suffix match), 0 otherwise. Return -1 if an error occurred.

Py_ssize_t PyUnicode_Find(PyObject *unicode, PyObject *substr, Py_ssize_t start, Py_ssize_t end, int direction)

Part of the Stable ABI.

Return the first position of substr in unicode[start:end] using the given direction (direction == 1 means to do a forward search, direction == -1 a backward search). The return value is the index of the first match; a value of -1 indicates that no match was found, and -2 indicates that an error occurred and an exception has been set.

Py_ssize_t PyUnicode_FindChar(PyObject *unicode, Py_UCS4 ch, Py_ssize_t start, Py_ssize_t end, int direction)

Part of the Stable ABI since version 3.7.

Return the first position of the character ch in unicode[start:end] using the given direction (direction == 1 means to do a forward search, direction == -1 a backward search). The return value is the index of the first match; a value of -1 indicates that no match was found, and -2 indicates that an error occurred and an exception has been set.

Added in version 3.3.

Змінено в версії 3.7: start and end are now adjusted to behave like unicode[start:end].

Py_ssize_t PyUnicode_Count(PyObject *unicode, PyObject *substr, Py_ssize_t start, Py_ssize_t end)

Part of the Stable ABI.

Return the number of non-overlapping occurrences of substr in unicode[start:end]. Return -1 if an error occurred.

PyObject *PyUnicode_Replace(PyObject *unicode, PyObject *substr, PyObject *replstr, Py_ssize_t maxcount)

Return value: New reference. Part of the Stable ABI.

Replace at most maxcount occurrences of substr in unicode with replstr and return the resulting Unicode object. maxcount == -1 means replace all occurrences.

int PyUnicode_Compare(PyObject *left, PyObject *right)

Part of the Stable ABI.

Порівняйте два рядки та поверніть -1, 0, 1 для меншого, рівного та більшого відповідно.

Ця функція повертає -1 у разі помилки, тому слід викликати PyErr_Occurred(), щоб перевірити наявність помилок.

Дивись також

The PyUnicode_Equal() function.

int PyUnicode_Equal(PyObject *a, PyObject *b)

Part of the Stable ABI since version 3.14.

Test if two strings are equal:

• Return 1 if a is equal to b.

• Return 0 if a is not equal to b.

• Set a TypeError exception and return -1 if a or b is not a str object.

The function always succeeds if a and b are str objects.

The function works for str subclasses, but does not honor custom __eq__() method.

Дивись також

The PyUnicode_Compare() function.

Added in version 3.14.

int PyUnicode_EqualToUTF8AndSize(PyObject *unicode, const char *string, Py_ssize_t size)

Part of the Stable ABI since version 3.13.

Compare a Unicode object with a char buffer which is interpreted as being UTF-8 or ASCII encoded and return true (1) if they are equal, or false (0) otherwise. If the Unicode object contains surrogate code points (U+D800 - U+DFFF) or the C string is not valid UTF-8, false (0) is returned.

Ця функція не викликає винятків.

Added in version 3.13.

int PyUnicode_EqualToUTF8(PyObject *unicode, const char *string)

Part of the Stable ABI since version 3.13.

Similar to PyUnicode_EqualToUTF8AndSize(), but compute string length using strlen(). If the Unicode object contains null characters, false (0) is returned.

Added in version 3.13.

int PyUnicode_CompareWithASCIIString(PyObject *unicode, const char *string)

Part of the Stable ABI.

Compare a Unicode object, unicode, with string and return -1, 0, 1 for less than, equal, and greater than, respectively. It is best to pass only ASCII-encoded strings, but the function interprets the input string as ISO-8859-1 if it contains non-ASCII characters.

Ця функція не викликає винятків.

PyObject *PyUnicode_RichCompare(PyObject *left, PyObject *right, int op)

Return value: New reference. Part of the Stable ABI.

Rich порівнює два рядки Unicode та повертає одне з наступного:

• NULL у разі виникнення винятку

• Py_True or Py_False for successful comparisons

• Py_NotImplemented in case the type combination is unknown

Possible values for op are Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, and Py_LE.

PyObject *PyUnicode_Format(PyObject *format, PyObject *args)

Return value: New reference. Part of the Stable ABI.

Повертає новий рядковий об’єкт із format і args; це аналогічно format % args.

int PyUnicode_Contains(PyObject *unicode, PyObject *substr)

Part of the Stable ABI.

Check whether substr is contained in unicode and return true or false accordingly.

substr has to coerce to a one element Unicode string. -1 is returned if there was an error.

void PyUnicode_InternInPlace(PyObject **p_unicode)

Part of the Stable ABI.

Intern the argument *p_unicode in place. The argument must be the address of a pointer variable pointing to a Python Unicode string object. If there is an existing interned string that is the same as *p_unicode, it sets *p_unicode to it (releasing the reference to the old string object and creating a new strong reference to the interned string object), otherwise it leaves *p_unicode alone and interns it.

(Clarification: even though there is a lot of talk about references, think of this function as reference-neutral. You must own the object you pass in; after the call you no longer own the passed-in reference, but you newly own the result.)

This function never raises an exception. On error, it leaves its argument unchanged without interning it.

Instances of subclasses of str may not be interned, that is, PyUnicode_CheckExact(*p_unicode) must be true. If it is not, then – as with any other error – the argument is left unchanged.

Note that interned strings are not “immortal”. You must keep a reference to the result to benefit from interning.

PyObject *PyUnicode_InternFromString(const char *str)

Return value: New reference. Part of the Stable ABI.

A combination of PyUnicode_FromString() and PyUnicode_InternInPlace(), meant for statically allocated strings.

Return a new («owned») reference to either a new Unicode string object that has been interned, or an earlier interned string object with the same value.

Python may keep a reference to the result, or make it immortal, preventing it from being garbage-collected promptly. For interning an unbounded number of different strings, such as ones coming from user input, prefer calling PyUnicode_FromString() and PyUnicode_InternInPlace() directly.

unsigned int PyUnicode_CHECK_INTERNED(PyObject *str)

Return a non-zero value if str is interned, zero if not. The str argument must be a string; this is not checked. This function always succeeds.

Деталі реалізації CPython: A non-zero return value may carry additional information about how the string is interned. The meaning of such non-zero values, as well as each specific string’s intern-related details, may change between CPython versions.

PyUnicodeWriter

The PyUnicodeWriter API can be used to create a Python str object.

Added in version 3.14.

type PyUnicodeWriter

A Unicode writer instance.

The instance must be destroyed by PyUnicodeWriter_Finish() on success, or PyUnicodeWriter_Discard() on error.

PyUnicodeWriter *PyUnicodeWriter_Create(Py_ssize_t length)

Create a Unicode writer instance.

length must be greater than or equal to 0.

If length is greater than 0, preallocate an internal buffer of length characters.

Set an exception and return NULL on error.

PyObject *PyUnicodeWriter_Finish(PyUnicodeWriter *writer)

Return the final Python str object and destroy the writer instance.

Set an exception and return NULL on error.

The writer instance is invalid after this call.

void PyUnicodeWriter_Discard(PyUnicodeWriter *writer)

Discard the internal Unicode buffer and destroy the writer instance.

If writer is NULL, no operation is performed.

The writer instance is invalid after this call.

int PyUnicodeWriter_WriteChar(PyUnicodeWriter *writer, Py_UCS4 ch)

Write the single Unicode character ch into writer.

On success, return 0. On error, set an exception, leave the writer unchanged, and return -1.

int PyUnicodeWriter_WriteUTF8(PyUnicodeWriter *writer, const char *str, Py_ssize_t size)

Decode the string str from UTF-8 in strict mode and write the output into writer.

size is the string length in bytes. If size is equal to -1, call strlen(str) to get the string length.

On success, return 0. On error, set an exception, leave the writer unchanged, and return -1.

See also PyUnicodeWriter_DecodeUTF8Stateful().

int PyUnicodeWriter_WriteASCII(PyUnicodeWriter *writer, const char *str, Py_ssize_t size)

Write the ASCII string str into writer.

size is the string length in bytes. If size is equal to -1, call strlen(str) to get the string length.

str must only contain ASCII characters. The behavior is undefined if str contains non-ASCII characters.

On success, return 0. On error, set an exception, leave the writer unchanged, and return -1.

Added in version 3.14.

int PyUnicodeWriter_WriteWideChar(PyUnicodeWriter *writer, const wchar_t *str, Py_ssize_t size)

Write the wide string str into writer.

size is a number of wide characters. If size is equal to -1, call wcslen(str) to get the string length.

On success, return 0. On error, set an exception, leave the writer unchanged, and return -1.

int PyUnicodeWriter_WriteUCS4(PyUnicodeWriter *writer, Py_UCS4 *str, Py_ssize_t size)

Writer the UCS4 string str into writer.

size is a number of UCS4 characters.

On success, return 0. On error, set an exception, leave the writer unchanged, and return -1.

int PyUnicodeWriter_WriteStr(PyUnicodeWriter *writer, PyObject *obj)

Call PyObject_Str() on obj and write the output into writer.

On success, return 0. On error, set an exception, leave the writer unchanged, and return -1.

int PyUnicodeWriter_WriteRepr(PyUnicodeWriter *writer, PyObject *obj)

Call PyObject_Repr() on obj and write the output into writer.

On success, return 0. On error, set an exception, leave the writer unchanged, and return -1.

int PyUnicodeWriter_WriteSubstring(PyUnicodeWriter *writer, PyObject *str, Py_ssize_t start, Py_ssize_t end)

Write the substring str[start:end] into writer.

str must be Python str object. start must be greater than or equal to 0, and less than or equal to end. end must be less than or equal to str length.

On success, return 0. On error, set an exception, leave the writer unchanged, and return -1.

int PyUnicodeWriter_Format(PyUnicodeWriter *writer, const char *format, ...)

Similar to PyUnicode_FromFormat(), but write the output directly into writer.

On success, return 0. On error, set an exception, leave the writer unchanged, and return -1.

int PyUnicodeWriter_DecodeUTF8Stateful(PyUnicodeWriter *writer, const char *string, Py_ssize_t length, const char *errors, Py_ssize_t *consumed)

Decode the string str from UTF-8 with errors error handler and write the output into writer.

size is the string length in bytes. If size is equal to -1, call strlen(str) to get the string length.

errors is an error handler name, such as "replace". If errors is NULL, use the strict error handler.

If consumed is not NULL, set *consumed to the number of decoded bytes on success. If consumed is NULL, treat trailing incomplete UTF-8 byte sequences as an error.

On success, return 0. On error, set an exception, leave the writer unchanged, and return -1.

See also PyUnicodeWriter_WriteUTF8().

Deprecated API

The following API is deprecated.

type Py_UNICODE

This is a typedef of wchar_t, which is a 16-bit type or 32-bit type depending on the platform. Please use wchar_t directly instead.

Змінено в версії 3.3: У попередніх версіях це був 16-розрядний або 32-розрядний тип залежно від того, чи ви вибрали «вузьку» чи «широку» версію Unicode Python під час збирання.

Deprecated since version 3.13, removed in version 3.15.

int PyUnicode_READY(PyObject *unicode)

Do nothing and return 0. This API is kept only for backward compatibility, but there are no plans to remove it.

Added in version 3.3.

Застаріло починаючи з версії 3.10: This API does nothing since Python 3.12. Previously, this needed to be called for each string created using the old API (PyUnicode_FromUnicode() or similar).

unsigned int PyUnicode_IS_READY(PyObject *unicode)

Do nothing and return 1. This API is kept only for backward compatibility, but there are no plans to remove it.

Added in version 3.3.

Застаріло починаючи з версії 3.14: This API does nothing since Python 3.12. Previously, this could be called to check if PyUnicode_READY() is necessary.