# Objetos Unicode e Codecs

## Objetos Unicode

Desde a implementação da PEP 393 no Python 3.3, os objetos Unicode usam internamente uma variedade de representações para permitir o processamento de toda a gama de caracteres Unicode, mantendo a eficiência de memória. Há casos especiais para strings em que todos os pontos de código estão abaixo de 128, 256 ou 65536; caso contrário, os pontos de código devem estar abaixo de 1114112 (que é a gama completa de caracteres Unicode).

Py_UNICODE* and UTF-8 representations are created on demand and cached in the Unicode object. The Py_UNICODE* representation is deprecated and inefficient.

Due to the transition between the old APIs and the new APIs, Unicode objects can internally be in two states depending on how they were created:

- “canonical” Unicode objects are all objects created by a non-deprecated Unicode API. They use the most efficient representation allowed by the implementation.

- “legacy” Unicode objects have been created through one of the deprecated APIs (typically `PyUnicode_FromUnicode()`) and only bear the Py_UNICODE* representation; you will have to call `PyUnicode_READY()` on them before calling any other API.

Nota

The “legacy” Unicode object will be removed in Python 3.12 with deprecated APIs. All Unicode objects will be “canonical” since then. See PEP 623 for more information.

### Tipo Unicode

Estes são os tipos básicos de objetos Unicode usados para a implementação Unicode em Python:

type Py_UCS4
type Py_UCS2
type Py_UCS1
  Parte da ABI Estável.

  Esses tipos são definições de tipo para tipos inteiros sem sinal, amplos o suficiente para conter caracteres de 32 bits, 16 bits e 8 bits, respectivamente. Ao lidar com caracteres Unicode simples, use `Py_UCS4`.

  Novo na versão 3.3.

type Py_UNICODE

  Este é um typedef de `wchar_t`, que é um tipo de 16 bits ou 32 bits, dependendo da plataforma.

  Alterado na versão 3.3: Em versões anteriores, esse era um tipo de 16 bits ou de 32 bits, dependendo se você selecionava uma versão Unicode “estreita” ou “ampla” do Python no momento da construção.

type PyASCIIObject
type PyCompactUnicodeObject
type PyUnicodeObject

  Esses subtipos de `PyObject` representam um objeto Unicode do Python. Em quase todos os casos, eles não devem ser usados diretamente, pois todas as funções da API que lidam com objetos Unicode recebem e retornam ponteiros `PyObject`.

  Novo na versão 3.3.

PyTypeObject PyUnicode_Type
  Parte da ABI Estável.

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

As seguintes APIs são macros C e funções estáticas embutidas para verificações rápidas e acesso a dados internos somente leitura de objetos Unicode:

int PyUnicode_Check(PyObject *obj)

  Retorna verdadeiro se o objeto obj for um objeto Unicode ou uma instância de um subtipo Unicode. Esta função sempre tem sucesso.

int PyUnicode_CheckExact(PyObject *obj)

  Retorna verdadeiro se o objeto obj for um objeto Unicode, mas não uma instância de um subtipo. Esta função sempre tem sucesso.

int PyUnicode_READY(PyObject *unicode)

  Ensure the string object o is in the “canonical” representation. This is required before using any of the access macros described below.

  Returns `0` on success and `-1` with an exception set on failure, which in particular happens if memory allocation fails.

  Novo na versão 3.3.

  Descontinuado desde a versão 3.10, será removido na versão 3.12: This API will be removed with `PyUnicode_FromUnicode()`.

Py_ssize_t PyUnicode_GET_LENGTH(PyObject *unicode)

  Retorna o comprimento da string Unicode, em pontos de código. unicode deve ser um objeto Unicode na representação “canônica” (não marcado).

  Novo na versão 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 macro. Make sure `PyUnicode_READY()` has been called before accessing this.

  Novo na versão 3.3.

PyUnicode_WCHAR_KIND
PyUnicode_1BYTE_KIND
PyUnicode_2BYTE_KIND
PyUnicode_4BYTE_KIND

  Valores de retorno da macro `PyUnicode_KIND()`.

  Novo na versão 3.3.

  Descontinuado desde a versão 3.10, será removido na versão 3.12: `PyUnicode_WCHAR_KIND` is deprecated.

int PyUnicode_KIND(PyObject *unicode)

  Retorna uma das constantes do tipo PyUnicode (veja acima) que indicam quantos bytes por caractere este objeto Unicode usa para armazenar seus dados. unicode precisa ser um objeto Unicode na representação “canônica” (não marcado).

  Novo na versão 3.3.

void *PyUnicode_DATA(PyObject *unicode)

  Retorna um ponteiro vazio para o buffer Unicode bruto. unicode deve ser um objeto Unicode na representação “canônica” (não marcado).

  Novo na versão 3.3.

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

  Escreva em uma representação canônica data (conforme obtido com `PyUnicode_DATA()`). Esta função não realiza verificações de sanidade e destina-se ao uso em laços. O chamador deve armazenar em cache o valor de type e o ponteiro data conforme obtidos de outras chamadas. índice é o índice na string (começa em 0) e value é o novo valor do ponto de código que deve ser escrito naquele local.

  Novo na versão 3.3.

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

  Lê um ponto de código de uma representação canônica data (conforme obtido com `PyUnicode_DATA()`). Nenhuma verificação ou chamada pronta é realizada.

  Novo na versão 3.3.

Py_UCS4 PyUnicode_READ_CHAR(PyObject *unicode, Py_ssize_t index)

  Lê um caractere de um objeto Unicode unicode, que deve estar na representação “canônica”. Isso é menos eficiente do que `PyUnicode_READ()` se você fizer várias leituras consecutivas.

  Novo na versão 3.3.

Py_UCS4 PyUnicode_MAX_CHAR_VALUE(PyObject *unicode)

  Retorna o ponto de código máximo adequado para criar outra string baseada em unicode, que deve estar na representação “canônica”. Isso é sempre uma aproximação, mas é mais eficiente do que iterar sobre a string.

  Novo na versão 3.3.

Py_ssize_t PyUnicode_GET_SIZE(PyObject *unicode)

  Return the size of the deprecated `Py_UNICODE` representation, in code units (this includes surrogate pairs as 2 units). unicode has to be a Unicode object (not checked).

  Descontinuado desde a versão 3.3, será removido na versão 3.12: Part of the old-style Unicode API, please migrate to using `PyUnicode_GET_LENGTH()`.

Py_ssize_t PyUnicode_GET_DATA_SIZE(PyObject *unicode)

  Return the size of the deprecated `Py_UNICODE` representation in bytes. unicode has to be a Unicode object (not checked).

  Descontinuado desde a versão 3.3, será removido na versão 3.12: Part of the old-style Unicode API, please migrate to using `PyUnicode_GET_LENGTH()`.

Py_UNICODE *PyUnicode_AS_UNICODE(PyObject *unicode)
const char *PyUnicode_AS_DATA(PyObject *unicode)

  Return a pointer to a `Py_UNICODE` representation of the object. The returned buffer is always terminated with an extra null code point. It may also contain embedded null code points, which would cause the string to be truncated when used in most C functions. The `AS_DATA` form casts the pointer to const char*. The unicode argument has to be a Unicode object (not checked).

  Alterado na versão 3.3: This function is now inefficient – because in many cases the `Py_UNICODE` representation does not exist and needs to be created – and can fail (return `NULL` with an exception set). Try to port the code to use the new `PyUnicode_nBYTE_DATA()` macros or use `PyUnicode_WRITE()` or `PyUnicode_READ()`.

  Descontinuado desde a versão 3.3, será removido na versão 3.12: Part of the old-style Unicode API, please migrate to using the `PyUnicode_nBYTE_DATA()` family of macros.

int PyUnicode_IsIdentifier(PyObject *unicode)
  Parte da ABI Estável.

  Retorna `1` se a string é um identificador válido conforme a definição da linguagem, seção Identificadores e palavras-chave. Do contrário, retorna `0`.

  Alterado na versão 3.9: A função não chama mais `Py_FatalError()` se a string não estiver pronta.

### Propriedade de caracteres Unicode

O Unicode fornece muitas propriedades de caracteres diferentes. As mais frequentemente necessárias estão disponíveis por meio destas macros, que são mapeadas para funções C, dependendo da configuração do Python.

int Py_UNICODE_ISSPACE(Py_UCS4 ch)

  Retorna `1` ou `0` dependendo se ch é um caractere de espaço em branco.

int Py_UNICODE_ISLOWER(Py_UCS4 ch)

  Retorna `1` ou `0` dependendo se ch é um caractere minúsculo.

int Py_UNICODE_ISUPPER(Py_UCS4 ch)

  Retorna `1` ou `0` dependendo se ch é um caractere maiúsculo.

int Py_UNICODE_ISTITLE(Py_UCS4 ch)

  Retorna `1` ou `0` dependendo se ch é um caractere em TitleCase.

int Py_UNICODE_ISLINEBREAK(Py_UCS4 ch)

  Retorna `1` ou `0` dependendo se ch é um caractere de quebra de linha.

int Py_UNICODE_ISDECIMAL(Py_UCS4 ch)

  Retorna `1` ou `0` dependendo se ch é um caractere decimal.

int Py_UNICODE_ISDIGIT(Py_UCS4 ch)

  Retorna `1` ou `0` dependendo se ch é um caractere de dígito.

int Py_UNICODE_ISNUMERIC(Py_UCS4 ch)

  Retorna `1` ou `0` dependendo se ch é um caractere numérico.

int Py_UNICODE_ISALPHA(Py_UCS4 ch)

  Retorna `1` ou `0` dependendo se ch é um caractere alfabético.

int Py_UNICODE_ISALNUM(Py_UCS4 ch)

  Retorna `1` ou `0` dependendo se ch é um caractere alfanumérico.

int Py_UNICODE_ISPRINTABLE(Py_UCS4 ch)

  Return `1` or `0` depending on whether ch is a printable character. Nonprintable characters are those characters defined in the Unicode character database as “Other” or “Separator”, excepting the ASCII space (0x20) which is considered printable. (Note that printable characters in this context are those which should not be escaped when `repr()` is invoked on a string. It has no bearing on the handling of strings written to `sys.stdout` or `sys.stderr`.)

These APIs can be used for fast direct character conversions:

Py_UCS4 Py_UNICODE_TOLOWER(Py_UCS4 ch)

  Return the character ch converted to lower case.

  Obsoleto desde a versão 3.3: This function uses simple case mappings.

Py_UCS4 Py_UNICODE_TOUPPER(Py_UCS4 ch)

  Return the character ch converted to upper case.

  Obsoleto desde a versão 3.3: This function uses simple case mappings.

Py_UCS4 Py_UNICODE_TOTITLE(Py_UCS4 ch)

  Return the character ch converted to title case.

  Obsoleto desde a versão 3.3: This function uses simple case mappings.

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 macro 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 macro 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 macro does not raise exceptions.

These APIs can be used to work with surrogates:

Py_UNICODE_IS_SURROGATE(ch)

  Check if ch is a surrogate (`0xD800 <= ch <= 0xDFFF`).

Py_UNICODE_IS_HIGH_SURROGATE(ch)

  Check if ch is a high surrogate (`0xD800 <= ch <= 0xDBFF`).

Py_UNICODE_IS_LOW_SURROGATE(ch)

  Check if ch is a low surrogate (`0xDC00 <= ch <= 0xDFFF`).

Py_UNICODE_JOIN_SURROGATES(high, low)

  Join two surrogate characters and return a single Py_UCS4 value. high and low are respectively the leading and trailing surrogates in a surrogate pair.

### Creating and accessing Unicode strings

To create Unicode objects and access their basic sequence properties, use these APIs:

PyObject *PyUnicode_New(Py_ssize_t size, Py_UCS4 maxchar)
  Retorna valor: Nova referência.

  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.

  Novo na versão 3.3.

PyObject *PyUnicode_FromKindAndData(int kind, const void *buffer, Py_ssize_t size)
  Retorna valor: Nova referência.

  Cria um novo objeto Unicode com o tipo type fornecido (os valores possíveis são `PyUnicode_1BYTE_KIND` etc., conforme retornado por `PyUnicode_KIND()`). O buffer deve apontar para um array de unidades com size de 1, 2 ou 4 bytes por caractere, conforme fornecido pelo tipo.

  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`).

  Novo na versão 3.3.

PyObject *PyUnicode_FromStringAndSize(const char *str, Py_ssize_t size)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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. If the buffer is not `NULL`, the return value might be a shared object, i.e. modification of the data is not allowed.

  If str is `NULL`, this function behaves like `PyUnicode_FromUnicode()` with the buffer set to `NULL`. This usage is deprecated in favor of `PyUnicode_New()`, and will be removed in Python 3.12.

PyObject *PyUnicode_FromString(const char *str)
  Retorna valor: Nova referência. Parte da ABI Estável.

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

PyObject *PyUnicode_FromFormat(const char *format, ...)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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. The following format characters are allowed:

  Caracteres Formatados | Tipo | Comentário
  --- | --- | ---
  `%%` | n/d | O caractere literal %.
  `%c` | int | A single character, represented as a C int.
  `%d` | int | Equivalente a `printf("%d")`. [1]
  `%u` | unsigned int | Equivalente a `printf("%u")`. [1]
  `%ld` | long | Equivalente a `printf("%ld")`. [1]
  `%li` | long | Equivalent to `printf("%li")`. [1]
  `%lu` | unsigned long | Equivalente a `printf("%lu")`. [1]
  `%lld` | long long | Equivalent to `printf("%lld")`. [1]
  `%lli` | long long | Equivalent to `printf("%lli")`. [1]
  `%llu` | unsigned long long | Equivalent to `printf("%llu")`. [1]
  `%zd` | `Py_ssize_t` | Equivalente a `printf("%zd")`. [1]
  `%zi` | `Py_ssize_t` | Equivalent to `printf("%zi")`. [1]
  `%zu` | size_t | Equivalente a `printf("%zu")`. [1]
  `%i` | int | Equivalente a `printf("%i")`. [1]
  `%x` | int | Equivalente a `printf("%x")`. [1]
  `%s` | const char* | Uma matriz de caracteres C com terminação nula.
  `%p` | const void* | A representação hexadecimal de um ponteiro C. Principalmente equivalente a `printf("%p")` exceto que é garantido que comece com o literal `0x` independentemente do que o `printf` da plataforma ceda.
  `%A` | PyObject* | The result of calling `ascii()`.
  `%U` | PyObject* | A Unicode object.
  `%V` | PyObject*, const char* | A Unicode object (which may be `NULL`) and a null-terminated C character array as a second parameter (which will be used, if the first parameter is `NULL`).
  `%S` | PyObject* | The result of calling `PyObject_Str()`.
  `%R` | PyObject* | The result of calling `PyObject_Repr()`.

  An unrecognized format character causes all the rest of the format string to be copied as-is to the result string, and any extra arguments discarded.

  Nota

  The width formatter unit is number of characters rather than bytes. The precision formatter unit is number of bytes 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`).

  [1] (1,2,3,4,5,6,7,8,9,10,11,12,13)

  For integer specifiers (d, u, ld, li, lu, lld, lli, llu, zd, zi, zu, i, x): the 0-conversion flag has effect even when a precision is given.

  Alterado na versão 3.2: Suporte adicionado para `"%lld"` e `"%llu"`.

  Alterado na versão 3.3: Support for `"%li"`, `"%lli"` and `"%zi"` added.

  Alterado na versão 3.4: Support width and precision formatter for `"%s"`, `"%A"`, `"%U"`, `"%V"`, `"%S"`, `"%R"` added.

PyObject *PyUnicode_FromFormatV(const char *format, va_list vargs)
  Retorna valor: Nova referência. Parte da ABI Estável.

  Identical to `PyUnicode_FromFormat()` except that it takes exactly two arguments.

PyObject *PyUnicode_FromObject(PyObject *obj)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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`.

PyObject *PyUnicode_FromEncodedObject(PyObject *obj, const char *encoding, const char *errors)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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 Built-in Codecs 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.

Py_ssize_t PyUnicode_GetLength(PyObject *unicode)
  Parte da ABI Estável desde a versão 3.7.

  Return the length of the Unicode object, in code points.

  Novo na versão 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.

  Novo na versão 3.3.

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

  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.

  Novo na versão 3.3.

int PyUnicode_WriteChar(PyObject *unicode, Py_ssize_t index, Py_UCS4 character)
  Parte da ABI Estável desde a versão 3.7.

  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).

  Novo na versão 3.3.

Py_UCS4 PyUnicode_ReadChar(PyObject *unicode, Py_ssize_t index)
  Parte da ABI Estável desde a versão 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.

  Novo na versão 3.3.

PyObject *PyUnicode_Substring(PyObject *unicode, Py_ssize_t start, Py_ssize_t end)
  Retorna valor: Nova referência. Parte da ABI Estável desde a versão 3.7.

  Return a substring of unicode, from character index start (included) to character index end (excluded). Negative indices are not supported.

  Novo na versão 3.3.

Py_UCS4 *PyUnicode_AsUCS4(PyObject *unicode, Py_UCS4 *buffer, Py_ssize_t buflen, int copy_null)
  Parte da ABI Estável desde a versão 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.

  Novo na versão 3.3.

Py_UCS4 *PyUnicode_AsUCS4Copy(PyObject *unicode)
  Parte da ABI Estável desde a versão 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.

  Novo na versão 3.3.

### Deprecated Py_UNICODE APIs

Descontinuado desde a versão 3.3, será removido na versão 3.12.

These API functions are deprecated with the implementation of PEP 393. Extension modules can continue using them, as they will not be removed in Python 3.x, but need to be aware that their use can now cause performance and memory hits.

PyObject *PyUnicode_FromUnicode(const Py_UNICODE *u, Py_ssize_t size)
  Retorna valor: Nova referência.

  Create a Unicode object from the Py_UNICODE buffer u of the given size. u may be `NULL` which causes the contents to be undefined. It is the user’s responsibility to fill in the needed data. The buffer is copied into the new object.

  If the buffer is not `NULL`, the return value might be a shared object. Therefore, modification of the resulting Unicode object is only allowed when u is `NULL`.

  If the buffer is `NULL`, `PyUnicode_READY()` must be called once the string content has been filled before using any of the access macros such as `PyUnicode_KIND()`.

  Descontinuado desde a versão 3.3, será removido na versão 3.12: Part of the old-style Unicode API, please migrate to using `PyUnicode_FromKindAndData()`, `PyUnicode_FromWideChar()`, or `PyUnicode_New()`.

Py_UNICODE *PyUnicode_AsUnicode(PyObject *unicode)

  Return a read-only pointer to the Unicode object’s internal `Py_UNICODE` buffer, or `NULL` on error. This will create the Py_UNICODE* representation of the object if it is not yet available. The buffer is always terminated with an extra null code point. Note that the resulting `Py_UNICODE` string may also contain embedded null code points, which would cause the string to be truncated when used in most C functions.

  Descontinuado desde a versão 3.3, será removido na versão 3.12: Part of the old-style Unicode API, please migrate to using `PyUnicode_AsUCS4()`, `PyUnicode_AsWideChar()`, `PyUnicode_ReadChar()` or similar new APIs.

Py_UNICODE *PyUnicode_AsUnicodeAndSize(PyObject *unicode, Py_ssize_t *size)

  Like `PyUnicode_AsUnicode()`, but also saves the `Py_UNICODE()` array length (excluding the extra null terminator) in size. Note that the resulting Py_UNICODE* string may contain embedded null code points, which would cause the string to be truncated when used in most C functions.

  Novo na versão 3.3.

  Descontinuado desde a versão 3.3, será removido na versão 3.12: Part of the old-style Unicode API, please migrate to using `PyUnicode_AsUCS4()`, `PyUnicode_AsWideChar()`, `PyUnicode_ReadChar()` or similar new APIs.

Py_ssize_t PyUnicode_GetSize(PyObject *unicode)
  Parte da ABI Estável.

  Return the size of the deprecated `Py_UNICODE` representation, in code units (this includes surrogate pairs as 2 units).

  Descontinuado desde a versão 3.3, será removido na versão 3.12: Part of the old-style Unicode API, please migrate to using `PyUnicode_GET_LENGTH()`.

### Locale Encoding

The current locale encoding can be used to decode text from the operating system.

PyObject *PyUnicode_DecodeLocaleAndSize(const char *str, Py_ssize_t length, const char *errors)
  Retorna valor: Nova referência. Parte da ABI Estável desde a versão 3.7.

  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 `Py_FileSystemDefaultEncoding` (the locale encoding read at Python startup).

  This function ignores the Python UTF-8 Mode.

  Ver também

  The `Py_DecodeLocale()` function.

  Novo na versão 3.3.

  Alterado na versão 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`.

PyObject *PyUnicode_DecodeLocale(const char *str, const char *errors)
  Retorna valor: Nova referência. Parte da ABI Estável desde a versão 3.7.

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

  Novo na versão 3.3.

PyObject *PyUnicode_EncodeLocale(PyObject *unicode, const char *errors)
  Retorna valor: Nova referência. Parte da ABI Estável desde a versão 3.7.

  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 `Py_FileSystemDefaultEncoding` (the locale encoding read at Python startup).

  This function ignores the Python UTF-8 Mode.

  Ver também

  The `Py_EncodeLocale()` function.

  Novo na versão 3.3.

  Alterado na versão 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`.

### File System Encoding

To encode and decode file names and other environment strings, `Py_FileSystemDefaultEncoding` should be used as the encoding, and `Py_FileSystemDefaultEncodeErrors` should be used as the 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)
  Parte da ABI Estável.

  ParseTuple 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 a PyBytesObject* which must be released when it is no longer used.

  Novo na versão 3.1.

  Alterado na versão 3.6: Aceita um objeto caminho ou similar.

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)
  Parte da ABI Estável.

  ParseTuple 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 a PyUnicodeObject* which must be released when it is no longer used.

  Novo na versão 3.2.

  Alterado na versão 3.6: Aceita um objeto caminho ou similar.

PyObject *PyUnicode_DecodeFSDefaultAndSize(const char *str, Py_ssize_t size)
  Retorna valor: Nova referência. Parte da ABI Estável.

  Decode a string from the filesystem encoding and error handler.

  If `Py_FileSystemDefaultEncoding` is not set, fall back to the locale encoding.

  `Py_FileSystemDefaultEncoding` is initialized at startup from the locale encoding and cannot be modified later. If you need to decode a string from the current locale encoding, use `PyUnicode_DecodeLocaleAndSize()`.

  Ver também

  The `Py_DecodeLocale()` function.

  Alterado na versão 3.6: Use `Py_FileSystemDefaultEncodeErrors` error handler.

PyObject *PyUnicode_DecodeFSDefault(const char *str)
  Retorna valor: Nova referência. Parte da ABI Estável.

  Decode a null-terminated string from the filesystem encoding and error handler.

  If `Py_FileSystemDefaultEncoding` is not set, fall back to the locale encoding.

  Use `PyUnicode_DecodeFSDefaultAndSize()` if you know the string length.

  Alterado na versão 3.6: Use `Py_FileSystemDefaultEncodeErrors` error handler.

PyObject *PyUnicode_EncodeFSDefault(PyObject *unicode)
  Retorna valor: Nova referência. Parte da ABI Estável.

  Encode a Unicode object to `Py_FileSystemDefaultEncoding` with the `Py_FileSystemDefaultEncodeErrors` error handler, and return `bytes`. Note that the resulting `bytes` object may contain null bytes.

  If `Py_FileSystemDefaultEncoding` is not set, fall back to the locale encoding.

  `Py_FileSystemDefaultEncoding` is initialized at startup from the locale encoding and cannot be modified later. If you need to encode a string to the current locale encoding, use `PyUnicode_EncodeLocale()`.

  Ver também

  The `Py_EncodeLocale()` function.

  Novo na versão 3.2.

  Alterado na versão 3.6: Use `Py_FileSystemDefaultEncodeErrors` error handler.

### wchar_t Support

`wchar_t` support for platforms which support it:

PyObject *PyUnicode_FromWideChar(const wchar_t *wstr, Py_ssize_t size)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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)
  Parte da ABI Estável.

  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)
  Parte da ABI Estável desde a versão 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.

  Novo na versão 3.2.

  Alterado na versão 3.7: Raises a `ValueError` if size is `NULL` and the wchar_t* string contains null characters.

## Built-in Codecs

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 variable `Py_FileSystemDefaultEncoding` internally. This variable should be treated as read-only: on some systems, it will be a pointer to a static string, on others, it will change at run-time (such as when the application invokes setlocale).

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.

### Generic Codecs

These are the generic codec APIs:

PyObject *PyUnicode_Decode(const char *str, Py_ssize_t size, const char *encoding, const char *errors)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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 Codecs

These are the UTF-8 codec APIs:

PyObject *PyUnicode_DecodeUTF8(const char *str, Py_ssize_t size, const char *errors)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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.

PyObject *PyUnicode_AsUTF8String(PyObject *unicode)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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.

const char *PyUnicode_AsUTF8AndSize(PyObject *unicode, Py_ssize_t *size)
  Parte da ABI Estável desde a versão 3.10.

  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.

  In the case of an error, `NULL` is returned with an exception set and no size is stored.

  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.

  Novo na versão 3.3.

  Alterado na versão 3.7: The return type is now `const char *` rather of `char *`.

  Alterado na versão 3.10: This function is a part of the limited API.

const char *PyUnicode_AsUTF8(PyObject *unicode)

  As `PyUnicode_AsUTF8AndSize()`, but does not store the size.

  Novo na versão 3.3.

  Alterado na versão 3.7: The return type is now `const char *` rather of `char *`.

### UTF-32 Codecs

These are the UTF-32 codec APIs:

PyObject *PyUnicode_DecodeUTF32(const char *str, Py_ssize_t size, const char *errors, int *byteorder)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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.

  Return `NULL` if an exception was raised by the codec.

PyObject *PyUnicode_DecodeUTF32Stateful(const char *str, Py_ssize_t size, const char *errors, int *byteorder, Py_ssize_t *consumed)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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.

PyObject *PyUnicode_AsUTF32String(PyObject *unicode)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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 Codecs

These are the UTF-16 codec APIs:

PyObject *PyUnicode_DecodeUTF16(const char *str, Py_ssize_t size, const char *errors, int *byteorder)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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.

  Return `NULL` if an exception was raised by the codec.

PyObject *PyUnicode_DecodeUTF16Stateful(const char *str, Py_ssize_t size, const char *errors, int *byteorder, Py_ssize_t *consumed)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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.

PyObject *PyUnicode_AsUTF16String(PyObject *unicode)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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 Codecs

These are the UTF-7 codec APIs:

PyObject *PyUnicode_DecodeUTF7(const char *str, Py_ssize_t size, const char *errors)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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.

### Unicode-Escape Codecs

These are the “Unicode Escape” codec APIs:

PyObject *PyUnicode_DecodeUnicodeEscape(const char *str, Py_ssize_t size, const char *errors)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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.

### Raw-Unicode-Escape Codecs

These are the “Raw Unicode Escape” codec APIs:

PyObject *PyUnicode_DecodeRawUnicodeEscape(const char *str, Py_ssize_t size, const char *errors)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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.

### Latin-1 Codecs

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.

PyObject *PyUnicode_DecodeLatin1(const char *str, Py_ssize_t size, const char *errors)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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.

### ASCII Codecs

These are the ASCII codec APIs. Only 7-bit ASCII data is accepted. All other codes generate errors.

PyObject *PyUnicode_DecodeASCII(const char *str, Py_ssize_t size, const char *errors)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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.

### Character Map Codecs

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.

These are the mapping codec APIs:

PyObject *PyUnicode_DecodeCharmap(const char *str, Py_ssize_t length, PyObject *mapping, const char *errors)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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.

PyObject *PyUnicode_AsCharmapString(PyObject *unicode, PyObject *mapping)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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.

PyObject *PyUnicode_Translate(PyObject *unicode, PyObject *table, const char *errors)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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.

### MBCS codecs for Windows

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.

PyObject *PyUnicode_DecodeMBCS(const char *str, Py_ssize_t size, const char *errors)
  Retorna valor: Nova referência. Parte da ABI Estável on Windows desde a versão 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)
  Retorna valor: Nova referência. Parte da ABI Estável on Windows desde a versão 3.7.

  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.

PyObject *PyUnicode_AsMBCSString(PyObject *unicode)
  Retorna valor: Nova referência. Parte da ABI Estável on Windows desde a versão 3.7.

  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.

PyObject *PyUnicode_EncodeCodePage(int code_page, PyObject *unicode, const char *errors)
  Retorna valor: Nova referência. Parte da ABI Estável on Windows desde a versão 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.

  Novo na versão 3.3.

### Methods & Slots

## Methods and Slot Functions

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.

They all return `NULL` or `-1` if an exception occurs.

PyObject *PyUnicode_Concat(PyObject *left, PyObject *right)
  Retorna valor: Nova referência. Parte da ABI Estável.

  Concat two strings giving a new Unicode string.

PyObject *PyUnicode_Split(PyObject *unicode, PyObject *sep, Py_ssize_t maxsplit)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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.

PyObject *PyUnicode_Splitlines(PyObject *unicode, int keepends)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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)
  Retorna valor: Nova referência. Parte da ABI Estável.

  Join a sequence of strings using the given separator and return the resulting Unicode string.

Py_ssize_t PyUnicode_Tailmatch(PyObject *unicode, PyObject *substr, Py_ssize_t start, Py_ssize_t end, int direction)
  Parte da ABI Estável.

  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)
  Parte da ABI Estável.

  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)
  Parte da ABI Estável desde a versão 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.

  Novo na versão 3.3.

  Alterado na versão 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)
  Parte da ABI Estável.

  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)
  Retorna valor: Nova referência. Parte da ABI Estável.

  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)
  Parte da ABI Estável.

  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.

int PyUnicode_CompareWithASCIIString(PyObject *unicode, const char *string)
  Parte da ABI Estável.

  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.

  This function does not raise exceptions.

PyObject *PyUnicode_RichCompare(PyObject *left, PyObject *right, int op)
  Retorna valor: Nova referência. Parte da ABI Estável.

  Rich compare two Unicode strings and return one of the following:

  - `NULL` in case an exception was raised

  - `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)
  Retorna valor: Nova referência. Parte da ABI Estável.

  Return a new string object from format and args; this is analogous to `format % args`.

int PyUnicode_Contains(PyObject *unicode, PyObject *substr)
  Parte da ABI Estável.

  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)
  Parte da ABI Estável.

  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 (creating a new strong reference). (Clarification: even though there is a lot of talk about references, think of this function as reference-neutral; you own the object after the call if and only if you owned it before the call.)

PyObject *PyUnicode_InternFromString(const char *str)
  Retorna valor: Nova referência. Parte da ABI Estável.

  A combination of `PyUnicode_FromString()` and `PyUnicode_InternInPlace()`, returning either a new Unicode string object that has been interned, or a new (“owned”) reference to an earlier interned string object with the same value.