Since the implementation of PEP 393 in Python 3.3, Unicode objects internally use a variety of representations, in order to allow handling the complete range of Unicode characters while staying memory efficient. There are special cases for strings where all code points are below 128, 256, or 65536; otherwise, code points must be below 1114112 (which is the full Unicode range).
UTF-8 表示法會在需要時建立並快取在 Unicode 物件中。
備註
自 Python 3.12 起，已移除 Py_UNICODE 表示法，並標示為已棄用的 API。更多資訊請參閱 PEP 623。
這些是 Python 中用於 Unicode 實作的基本 Unicode 物件型別：
These types are typedefs for unsigned integer types wide enough to contain
characters of 32 bits, 16 bits and 8 bits, respectively. When dealing with
single Unicode characters, use Py_UCS4.
在 3.3 版被加入.
This is a typedef of wchar_t, which is a 16-bit type or 32-bit type
depending on the platform.
在 3.3 版的變更: In previous versions, this was a 16-bit type or a 32-bit type depending on whether you selected a "narrow" or "wide" Unicode version of Python at build time.
Deprecated since version 3.13, will be removed in version 3.15.
These subtypes of PyObject represent a Python Unicode object. In
almost all cases, they shouldn't be used directly, since all API functions
that deal with Unicode objects take and return PyObject pointers.
在 3.3 版被加入.
This instance of PyTypeObject represents the Python Unicode type.
It is exposed to Python code as str.
This instance of PyTypeObject represents the Python Unicode
iterator type. It is used to iterate over Unicode string objects.
The following APIs are C macros and static inlined functions for fast checks and access to internal read-only data of Unicode objects:
Return true if the object obj is a Unicode object or an instance of a Unicode subtype. This function always succeeds.
Return true if the object obj is a Unicode object, but not an instance of a subtype. This function always succeeds.
回傳 0。此 API 僅保留以維持向後相容性。
在 3.3 版被加入.
在 3.10 版之後被棄用: 自 Python 3.12 起，此 API 不再執行任何動作。
Return the length of the Unicode string, in code points. unicode has to be a Unicode object in the "canonical" representation (not checked).
在 3.3 版被加入.
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.
在 3.3 版被加入.
Return values of the PyUnicode_KIND() macro.
在 3.3 版被加入.
在 3.12 版的變更: PyUnicode_WCHAR_KIND 已被移除。
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).
在 3.3 版被加入.
Return a void pointer to the raw Unicode buffer. unicode has to be a Unicode object in the "canonical" representation (not checked).
在 3.3 版被加入.
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.
在 3.3 版被加入.
Read a code point from a canonical representation data (as obtained with
PyUnicode_DATA()). No checks or ready calls are performed.
在 3.3 版被加入.
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.
在 3.3 版被加入.
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.
在 3.3 版被加入.
Return 1 if the string is a valid identifier according to the language
definition, section Identifiers and keywords. Return 0 otherwise.
在 3.9 版的變更: The function does not call Py_FatalError() anymore if the string
is not ready.
Unicode provides many different character properties. The most often needed ones are available through these macros which are mapped to C functions depending on the Python configuration.
根據 ch 是否為可列印字元（如 str.isprintable() 所定義）來回傳 1 或 0。
這些 API 可用於快速直接字元轉換：
這些 API 可用於處理代理字元：
檢查 ch 是否為高代理字元 (high surrogate, 0xD800 <= ch <= 0xDBFF)。
檢查 ch 是否為低代理字元 (low surrogate, 0xDC00 <= ch <= 0xDFFF)。
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].
To create Unicode objects and access their basic sequence properties, use these APIs:
Create a new Unicode object. maxchar should be the true maximum code point to be placed in the string. As an approximation, it can be rounded up to the nearest value in the sequence 127, 255, 65535, 1114111.
This is the recommended way to allocate a new Unicode object. Objects created using this function are not resizable.
On error, set an exception and return NULL.
在 3.3 版被加入.
Create a new Unicode object with the given kind (possible values are
PyUnicode_1BYTE_KIND etc., as returned by
PyUnicode_KIND()). The buffer must point to an array of size
units of 1, 2 or 4 bytes per character, as given by the kind.
If necessary, the input buffer is copied and transformed into the
canonical representation. For example, if the buffer is a UCS4 string
(PyUnicode_4BYTE_KIND) and it consists only of codepoints in
the UCS1 range, it will be transformed into UCS1
(PyUnicode_1BYTE_KIND).
在 3.3 版被加入.
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.
此函式在以下情況下會引發 SystemError：
size < 0，
str 為 NULL 且 size > 0
在 3.12 版的變更: str == NULL 且 size > 0 不再被允許。
Create a Unicode object from a UTF-8 encoded null-terminated char buffer str.
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.
A conversion specifier contains two or more characters and has the following components, which must occur in this order:
The '%' character, which marks the start of the specifier.
Conversion flags (optional), which affect the result of some conversion types.
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.
Length modifier (optional).
Conversion type.
The conversion flag characters are:
旗標 |
含義 |
|---|---|
|
The conversion will be zero padded for numeric values. |
|
The converted value is left adjusted (overrides the |
The length modifiers for following integer conversions (d, i,
o, u, x, or X) specify the type of the argument
(int by default):
Modifier |
Types |
|---|---|
|
long 或 unsigned long |
|
long long 或 unsigned long long |
|
|
|
|
|
|
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 |
Type |
Comment |
|---|---|---|
|
n/a |
字面 |
|
Specified by the length modifier |
一個有符號 C 整數的十進位表示法。 |
|
Specified by the length modifier |
一個無符號 C 整數的十進位表示法。 |
|
Specified by the length modifier |
一個無符號 C 整數的八進位表示法。 |
|
Specified by the length modifier |
一個無符號 C 整數的十六進位表示法（小寫）。 |
|
Specified by the length modifier |
一個無符號 C 整數的十六進位表示法（大寫）。 |
|
int |
一個單一字元。 |
|
const char* 或 const wchar_t* |
一個以 null 結尾的 C 字元陣列。 |
|
const void* |
The hex representation of a C pointer.
Mostly equivalent to |
|
呼叫 |
|
|
一個 Unicode 物件。 |
|
|
PyObject*、const char* 或 const wchar_t* |
A Unicode object (which may be |
|
呼叫 |
|
|
呼叫 |
|
|
Get the fully qualified name of an object type;
call |
|
|
Similar to |
|
|
Get the fully qualified name of a type;
call |
|
|
Similar to |
備註
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 版的變更: 新增對 %T、%#T、%N 和 %#N 格式的支援。
Identical to PyUnicode_FromFormat() except that it takes exactly two
arguments.
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.
Objects other than Unicode or its subtypes will cause a TypeError.
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.
Decode an encoded object obj to a Unicode object.
bytes, bytearray and other
bytes-like objects
are decoded according to the given encoding and using the error handling
defined by errors. Both can be NULL to have the interface use the default
values (see 內建編解碼器 for details).
All other objects, including Unicode objects, cause a TypeError to be
set.
The API returns NULL if there was an error. The caller is responsible for
decref'ing the returned objects.
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.
.. versionadded:: 3.2
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.
Return the length of the Unicode object, in code points.
發生錯誤時，設定例外並回傳 -1。
在 3.3 版被加入.
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.
在 3.3 版被加入.
Fill a string with a character: write fill_char into
unicode[start:start+length].
Fail if fill_char is bigger than the string maximum character, or if the string has more than 1 reference.
Return the number of written character, or return -1 and raise an
exception on error.
在 3.3 版被加入.
Write a character to a string. The string must have been created through
PyUnicode_New(). Since Unicode strings are supposed to be immutable,
the string must not be shared, or have been hashed yet.
This function checks that unicode is a Unicode object, that the index is not out of bounds, and that the object can be modified safely (i.e. that it its reference count is one).
成功時回傳 0，發生錯誤時設定例外並回傳 -1。
在 3.3 版被加入.
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.
成功時回傳字元，發生錯誤時設定例外並回傳 -1。
在 3.3 版被加入.
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.
在 3.3 版被加入.
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.
在 3.3 版被加入.
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.
在 3.3 版被加入.
The current locale encoding can be used to decode text from the operating system.
Decode a string from UTF-8 on Android and VxWorks, or from the current
locale encoding on other platforms. The supported
error handlers are "strict" and "surrogateescape"
(PEP 383). The decoder uses "strict" error handler if
errors is NULL. str must end with a null character but
cannot contain embedded null characters.
Use PyUnicode_DecodeFSDefaultAndSize() to decode a string from
the filesystem encoding and error handler.
此函式會忽略 Python UTF-8 模式。
也參考
在 3.3 版被加入.
在 3.7 版的變更: The function now also uses the current locale encoding for the
surrogateescape error handler, except on Android. Previously, Py_DecodeLocale()
was used for the surrogateescape, and the current locale encoding was
used for strict.
類似於 PyUnicode_DecodeLocaleAndSize()，但使用 strlen() 計算字串長度。
在 3.3 版被加入.
Encode a Unicode object to UTF-8 on Android and VxWorks, or to the current
locale encoding on other platforms. The
supported error handlers are "strict" and "surrogateescape"
(PEP 383). The encoder uses "strict" error handler if
errors is NULL. Return a bytes object. unicode cannot
contain embedded null characters.
Use PyUnicode_EncodeFSDefault() to encode a string to the
filesystem encoding and error handler.
此函式會忽略 Python UTF-8 模式。
也參考
在 3.3 版被加入.
在 3.7 版的變更: The function now also uses the current locale encoding for the
surrogateescape error handler, except on Android. Previously,
Py_EncodeLocale()
was used for the surrogateescape, and the current locale encoding was
used for 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:
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.
在 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:
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.
在 3.2 版被加入.
在 3.6 版的變更: 接受一個 path-like object。
Decode a string from the filesystem encoding and error handler.
If you need to decode a string from the current locale encoding, use
PyUnicode_DecodeLocaleAndSize().
也參考
在 3.6 版的變更: The filesystem error handler is now used.
Decode a null-terminated string from the filesystem encoding and error handler.
如果字串長度已知，請使用 PyUnicode_DecodeFSDefaultAndSize()。
在 3.6 版的變更: The filesystem error handler is now used.
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().
也參考
在 3.2 版被加入.
在 3.6 版的變更: The filesystem error handler is now used.
對支援 wchar_t 的平台提供支援：
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.
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.
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.
在 3.2 版被加入.
在 3.7 版的變更: Raises a ValueError if size is NULL and the wchar_t*
string contains null characters.
Python provides a set of built-in codecs which are written in C for speed. All of these codecs are directly usable via the following functions.
Many of the following APIs take two arguments encoding and errors, and they
have the same semantics as the ones of the built-in str() string object
constructor.
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.
Error handling is set by errors which may also be set to NULL meaning to use
the default handling defined for the codec. Default error handling for all
built-in codecs is "strict" (ValueError is raised).
The codecs all use a similar interface. Only deviations from the following generic ones are documented for simplicity.
這些是泛用編解碼器的 API：
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.
Encode a Unicode object and return the result as Python bytes object.
encoding and errors have the same meaning as the parameters of the same
name in the Unicode encode() method. The codec to be used is looked up
using the Python codec registry. Return NULL if an exception was raised by
the codec.
這些是 UTF-8 編解碼器的 API：
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.
If consumed is NULL, behave like PyUnicode_DecodeUTF8(). If
consumed is not NULL, trailing incomplete UTF-8 byte sequences will not be
treated as an error. Those bytes will not be decoded and the number of bytes
that have been decoded will be stored in consumed.
Encode a Unicode object using UTF-8 and return the result as Python bytes
object. Error handling is "strict". Return NULL if an exception was
raised by the codec.
The function fails if the string contains surrogate code points
(U+D800 - U+DFFF).
Return a pointer to the UTF-8 encoding of the Unicode object, and
store the size of the encoded representation (in bytes) in size. The
size argument can be NULL; in this case no size will be stored. The
returned buffer always has an extra null byte appended (not included in
size), regardless of whether there are any other null code points.
發生錯誤時，設定例外並將 size 設為 -1（如果不是 NULL），並回傳 NULL。
The function fails if the string contains surrogate code points
(U+D800 - U+DFFF).
This caches the UTF-8 representation of the string in the Unicode object, and subsequent calls will return a pointer to the same buffer. The caller is not responsible for deallocating the buffer. The buffer is deallocated and pointers to it become invalid when the Unicode object is garbage collected.
在 3.3 版被加入.
在 3.7 版的變更: 回傳型別現在是 const char * 而不是 char *。
在 3.10 版的變更: This function is a part of the limited API.
與 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.
在 3.3 版被加入.
在 3.7 版的變更: 回傳型別現在是 const char * 而不是 char *。
這些是 UTF-32 編解碼器的 API：
Decode size bytes from a UTF-32 encoded buffer string and return the
corresponding Unicode object. errors (if non-NULL) defines the error
handling. It defaults to "strict".
If byteorder is non-NULL, the decoder starts decoding using the given byte
order:
*byteorder == -1: little endian
*byteorder == 0: native order
*byteorder == 1: big endian
If *byteorder is zero, and the first four bytes of the input data are a
byte order mark (BOM), the decoder switches to this byte order and the BOM is
not copied into the resulting Unicode string. If *byteorder is -1 or
1, any byte order mark is copied to the output.
After completion, *byteorder is set to the current byte order at the end of input data.
If byteorder is NULL, the codec starts in native order mode.
如果編解碼器引發例外則回傳 NULL。
If consumed is NULL, behave like PyUnicode_DecodeUTF32(). If
consumed is not NULL, PyUnicode_DecodeUTF32Stateful() will not treat
trailing incomplete UTF-32 byte sequences (such as a number of bytes not divisible
by four) as an error. Those bytes will not be decoded and the number of bytes
that have been decoded will be stored in consumed.
Return a Python byte string using the UTF-32 encoding in native byte
order. The string always starts with a BOM mark. Error handling is "strict".
Return NULL if an exception was raised by the codec.
這些是 UTF-16 編解碼器的 API：
Decode size bytes from a UTF-16 encoded buffer string and return the
corresponding Unicode object. errors (if non-NULL) defines the error
handling. It defaults to "strict".
If byteorder is non-NULL, the decoder starts decoding using the given byte
order:
*byteorder == -1: little endian
*byteorder == 0: native order
*byteorder == 1: big endian
If *byteorder is zero, and the first two bytes of the input data are a
byte order mark (BOM), the decoder switches to this byte order and the BOM is
not copied into the resulting Unicode string. If *byteorder is -1 or
1, any byte order mark is copied to the output (where it will result in
either a \ufeff or a \ufffe character).
After completion, *byteorder is set to the current byte order at the end
of input data.
If byteorder is NULL, the codec starts in native order mode.
如果編解碼器引發例外則回傳 NULL。
If consumed is NULL, behave like PyUnicode_DecodeUTF16(). If
consumed is not NULL, PyUnicode_DecodeUTF16Stateful() will not treat
trailing incomplete UTF-16 byte sequences (such as an odd number of bytes or a
split surrogate pair) as an error. Those bytes will not be decoded and the
number of bytes that have been decoded will be stored in consumed.
Return a Python byte string using the UTF-16 encoding in native byte
order. The string always starts with a BOM mark. Error handling is "strict".
Return NULL if an exception was raised by the codec.
這些是 UTF-7 編解碼器的 API：
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.
If consumed is NULL, behave like PyUnicode_DecodeUTF7(). If
consumed is not NULL, trailing incomplete UTF-7 base-64 sections will not
be treated as an error. Those bytes will not be decoded and the number of
bytes that have been decoded will be stored in consumed.
These are the "Unicode Escape" codec APIs:
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.
Encode a Unicode object using Unicode-Escape and return the result as a
bytes object. Error handling is "strict". Return NULL if an exception was
raised by the codec.
These are the "Raw Unicode Escape" codec APIs:
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.
Encode a Unicode object using Raw-Unicode-Escape and return the result as
a bytes object. Error handling is "strict". Return NULL if an exception
was raised by the codec.
These are the Latin-1 codec APIs: Latin-1 corresponds to the first 256 Unicode ordinals and only these are accepted by the codecs during encoding.
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.
Encode a Unicode object using Latin-1 and return the result as Python bytes
object. Error handling is "strict". Return NULL if an exception was
raised by the codec.
These are the ASCII codec APIs. Only 7-bit ASCII data is accepted. All other codes generate errors.
Create a Unicode object by decoding size bytes of the ASCII encoded string
str. Return NULL if an exception was raised by the codec.
Encode a Unicode object using ASCII and return the result as Python bytes
object. Error handling is "strict". Return NULL if an exception was
raised by the codec.
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：
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.
If mapping is NULL, Latin-1 decoding will be applied. Else
mapping must map bytes ordinals (integers in the range from 0 to 255)
to Unicode strings, integers (which are then interpreted as Unicode
ordinals) or None. Unmapped data bytes -- ones which cause a
LookupError, as well as ones which get mapped to None,
0xFFFE or '\ufffe', are treated as undefined mappings and cause
an error.
Encode a Unicode object using the given mapping object and return the
result as a bytes object. Error handling is "strict". Return NULL if an
exception was raised by the codec.
The mapping object must map Unicode ordinal integers to bytes objects,
integers in the range from 0 to 255 or None. Unmapped character
ordinals (ones which cause a LookupError) as well as mapped to
None are treated as "undefined mapping" and cause an error.
The following codec API is special in that maps Unicode to Unicode.
Translate a string by applying a character mapping table to it and return the
resulting Unicode object. Return NULL if an exception was raised by the
codec.
The mapping table must map Unicode ordinal integers to Unicode ordinal integers
or None (causing deletion of the character).
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.
errors has the usual meaning for codecs. It may be NULL which indicates to
use the default error handling.
These are the MBCS codec APIs. They are currently only available on Windows and use the Win32 MBCS converters to implement the conversions. Note that MBCS (or DBCS) is a class of encodings, not just one. The target encoding is defined by the user settings on the machine running the codec.
Create a Unicode object by decoding size bytes of the MBCS encoded string str.
Return NULL if an exception was raised by the codec.
If consumed is NULL, behave like PyUnicode_DecodeMBCS(). If
consumed is not NULL, PyUnicode_DecodeMBCSStateful() will not decode
trailing lead byte and the number of bytes that have been decoded will be stored
in consumed.
Similar to PyUnicode_DecodeMBCSStateful(), except uses the code page
specified by code_page.
Encode a Unicode object using MBCS and return the result as Python bytes
object. Error handling is "strict". Return NULL if an exception was
raised by the codec.
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.
在 3.3 版被加入.
The following APIs are capable of handling Unicode objects and strings on input (we refer to them as strings in the descriptions) and return Unicode objects or integers as appropriate.
如果發生例外，則回傳 NULL 或 -1。
Concat two strings giving a new Unicode string.
Split a string giving a list of Unicode strings. If sep is NULL, splitting
will be done at all whitespace substrings. Otherwise, splits occur at the given
separator. At most maxsplit splits will be done. If negative, no limit is
set. Separators are not included in the resulting list.
於錯誤發生時回傳 NULL 並設定例外。
等價於 str.split()。
Similar to PyUnicode_Split(), but splitting will be done beginning
at the end of the string.
於錯誤發生時回傳 NULL 並設定例外。
等價於 str.rsplit()。
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.
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 不得為空。
於錯誤發生時回傳 NULL 並設定例外。
等價於 str.partition()。
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 不得為空。
於錯誤發生時回傳 NULL 並設定例外。
等價於 str.rpartition()。
Join a sequence of strings using the given separator and return the resulting Unicode string.
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.
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.
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.
在 3.3 版被加入.
在 3.7 版的變更: start and end are now adjusted to behave like unicode[start:end].
Return the number of non-overlapping occurrences of substr in
unicode[start:end]. Return -1 if an error occurred.
Replace at most maxcount occurrences of substr in unicode with replstr and
return the resulting Unicode object. maxcount == -1 means replace all
occurrences.
Compare two strings and return -1, 0, 1 for less than, equal, and greater than,
respectively.
This function returns -1 upon failure, so one should call
PyErr_Occurred() to check for errors.
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.
此函式不會引發例外。
在 3.13 版被加入.
Similar to PyUnicode_EqualToUTF8AndSize(), but compute string
length using strlen().
If the Unicode object contains null characters, false (0) is returned.
在 3.13 版被加入.
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.
此函式不會引發例外。
Rich compare two Unicode strings and return one of the following:
NULL in case an exception was raised
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.
Return a new string object from format and args; this is analogous to
format % args.
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.
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.
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.
CPython 實作細節： Strings interned this way are made immortal.