Об’єкти та кодеки 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:
-
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 Py_UNICODE¶
Це визначення типу
wchar_t
, який є 16-бітним або 32-бітним типом залежно від платформи.Змінено в версії 3.3: У попередніх версіях це був 16-розрядний або 32-розрядний тип залежно від того, чи ви вибрали «вузьку» чи «широку» версію Unicode Python під час збирання.
Deprecated since version 3.13, will be removed in version 3.15.
-
type PyASCIIObject¶
-
type PyCompactUnicodeObject¶
-
type PyUnicodeObject¶
Ці підтипи
PyObject
представляють об’єкт Python Unicode. Майже у всіх випадках їх не слід використовувати напряму, оскільки всі функції API, які працюють з об’єктами Unicode, приймають і повертають покажчикиPyObject
.Added in version 3.3.
-
PyTypeObject PyUnicode_Type¶
- Part of the Stable ABI.
Цей екземпляр
PyTypeObject
представляє тип Python Unicode. Він доступний коду Python якstr
.
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.
-
int PyUnicode_READY(PyObject *unicode)¶
Returns
0
. This API is kept only for backward compatibility.Added in version 3.3.
Застаріло починаючи з версії 3.10: This API does nothing since Python 3.12.
-
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 into a canonical representation data (as obtained with
PyUnicode_DATA()
). This function performs no sanity checks, and is intended for usage in loops. The caller should cache the kind value and data pointer as obtained from other calls. index is the index in the string (starts at 0) and value is the new code point value which should be written to that location.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
, якщо рядок є дійсним ідентифікатором відповідно до визначення мови, розділ Ідентифікатори та ключові слова. Інакше поверніть0
.Змінено в версії 3.9: Функція більше не викликає
Py_FatalError()
, якщо рядок не готовий.
Властивості символів Unicode¶
Unicode надає багато різних властивостей символів. Найпотрібніші з них доступні через ці макроси, які зіставляються з функціями C залежно від конфігурації Python.
-
int Py_UNICODE_ISLOWER(Py_UCS4 ch)¶
Повертає «1» або «0» залежно від того, чи ch є символом нижнього регістру.
-
int Py_UNICODE_ISUPPER(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_ISNUMERIC(Py_UCS4 ch)¶
Повертає «1» або «0» залежно від того, чи є ch цифровим символом.
-
int Py_UNICODE_ISALNUM(Py_UCS4 ch)¶
Повертає «1» або «0» залежно від того, чи є ch буквено-цифровим символом.
-
int Py_UNICODE_ISPRINTABLE(Py_UCS4 ch)¶
Повертає «1» або «0» залежно від того, чи є ch символом для друку. Символи, що не друкуються, — це символи, визначені в базі даних символів Unicode як «Інші» або «Розділювачі», за винятком пробілу ASCII (0x20), який вважається придатним для друку. (Зауважте, що друковані символи в цьому контексті – це ті символи, які не слід екранувати, коли
repr()
викликається в рядку. Це не впливає на обробку рядків, записаних уsys.stdout
абоsys.stderr
.)
Ці API можна використовувати для швидкого прямого перетворення символів:
-
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_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.
Це рекомендований спосіб виділення нового об’єкта Unicode. Розмір об’єктів, створених за допомогою цієї функції, неможливо змінити.
On error, set an exception and return
NULL
.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.Специфікатор перетворення містить два або більше символів і має наступні компоненти, які мають відображатися в такому порядку:
Символ
'%'
, який позначає початок специфікатора.Прапорці перетворення (опціонально), які впливають на результат деяких типів перетворення.
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.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.Модифікатор довжини (необов’язково).
Тип перетворення.
Символи прапора перетворення:
Прапор
Значення
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
, orX
) 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
oruintmax_t
z
size_t
orssize_t
t
ptrdiff_t
The length modifier
l
for following conversionss
orV
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 literal0x
regardless of what the platform’sprintf
yields.A
Результат виклику
ascii()
.U
Об’єкт Unicode.
V
PyObject*, const char* or const wchar_t*
Об’єкт Unicode (який може бути
NULL
) і масив символів C із нульовим закінченням як другий параметр (який використовуватиметься, якщо перший параметрNULL
).S
Результат виклику
PyObject_Str()
.R
Результат виклику
PyObject_Repr()
.T
Get the fully qualified name of an object type; call
PyType_GetFullyQualifiedName()
.#T
Similar to
T
format, but use a colon (:
) as separator between the module name and the qualified name.N
Get the fully qualified name of a type; call
PyType_GetFullyQualifiedName()
.#N
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 modifierl
is used) for"%s"
and"%V"
(if thePyObject*
argument isNULL
), and a number of characters for"%A"
,"%U"
,"%S"
,"%R"
and"%V"
(if thePyObject*
argument is notNULL
).Примітка
Unlike to C
printf()
the0
flag has effect even when a precision is given for integer conversions (d
,i
,u
,o
,x
, orX
).Змінено в версії 3.2: Додано підтримку
"%lld"
і"%llu"
.Змінено в версії 3.3: Додано підтримку
"%li"
,"%lli"
і"%zi"
.Змінено в версії 3.4: Підтримка ширини та точного форматування для
"%s"
,"%A"
,"%U"
,"%V"
,"%S"
,"%R"
додано.Змінено в версії 3.12: Support for conversion specifiers
o
andX
. Support for length modifiersj
andt
. Length modifiers are now applied to all integer conversions. Length modifierl
is now applied to conversion specifierss
andV
. 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_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
, якщо сталася помилка. Виклик відповідає за декодування повернутих об’єктів.
-
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.Added in version 3.3.
-
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 посилання.
Повертає номер написаного символу або повертає
-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.
Записати символ у рядок. Рядок має бути створено через
PyUnicode_New()
. Оскільки рядки Юнікоду мають бути незмінними, рядок не можна надавати спільно або хешувати.Ця функція перевіряє, що unicode є об’єктом Unicode, що індекс не виходить за межі та чи можна безпечно змінювати об’єкт (тобто чи кількість посилань дорівнює одиниці).
Return
0
on success,-1
on error with an exception set.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, aSystemError
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 aMemoryError
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 usingstrlen()
.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.
ParseTuple converter: encode
str
objects – obtained directly or through theos.PathLike
interface – tobytes
usingPyUnicode_EncodeFSDefault()
;bytes
objects are output as-is. result must be a PyBytesObject* which must be released when it is no longer used.Added in version 3.1.
Змінено в версії 3.6: Приймає path-like object.
Щоб декодувати імена файлів у str
під час синтаксичного аналізу аргументів, слід використовувати конвертер "O&"
, передаючи PyUnicode_FSDecoder()
як функцію перетворення:
-
int PyUnicode_FSDecoder(PyObject *obj, void *result)¶
- Part of the Stable ABI.
ParseTuple converter: decode
bytes
objects – obtained either directly or indirectly through theos.PathLike
interface – tostr
usingPyUnicode_DecodeFSDefaultAndSize()
;str
objects are output as-is. result must be a PyUnicodeObject* which must be released when it is no longer used.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 resultingbytes
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, usingwcslen()
. ReturnNULL
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 sizewchar_t
characters are copied (excluding a possibly trailing null termination character). Return the number ofwchar_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 resultingwchar_t
string might contain null characters, which would cause the string to be truncated when used with most C functions. If size isNULL
and the wchar_t* string contains null characters aValueError
is raised.Returns a buffer allocated by
PyMem_New
(usePyMem_Free()
to free it) on success. On error, returnsNULL
and *size is undefined. Raises aMemoryError
if memory allocation is failed.Added in version 3.2.
Змінено в версії 3.7: Raises a
ValueError
if size isNULL
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
викликається).
Усі кодеки використовують подібний інтерфейс. Для простоти документуються лише відхилення від наступних загальних.
Загальні кодеки¶
Це загальні кодеки 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. ReturnNULL
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 returnNULL
.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()
, але не зберігає розмір.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 aLookupError
) 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_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. UseCP_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. Якщо значення від’ємне, обмеження не встановлено. Розділювачі не включені в отриманий список.
-
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_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 matchesunicode[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()
, щоб перевірити наявність помилок.
-
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 usingstrlen()
. 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_NotImplemented
in case the type combination is unknown
Possible values for op are
Py_GT
,Py_GE
,Py_EQ
,Py_NE
,Py_LT
, andPy_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()
andPyUnicode_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()
andPyUnicode_InternInPlace()
directly.Деталі реалізації CPython: Strings interned this way are made immortal.