Objetos y códecs Unicode
************************


Objetos Unicode
===============

Desde la implementación del **PEP 393** en Python 3.3, los objetos
Unicode utilizan internamente una variedad de representaciones, para
permitir el manejo del rango completo de caracteres Unicode mientras
se mantiene la eficiencia de memoria. Hay casos especiales para
cadenas de caracteres donde todos los puntos de código están por
debajo de 128, 256 o 65536; de lo contrario, los puntos de código
deben estar por debajo de 1114112 (que es el rango completo de
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.

Debido a la transición entre las API antiguas y las API nuevas, los
objetos Unicode pueden estar internamente en dos estados dependiendo
de cómo se crearon:

* Los objetos Unicode "canónicos" son todos los objetos creados por
  una API Unicode no obsoleta. Utilizan la representación más
  eficiente permitida por la implementación.

* Los objetos Unicode "heredados" se han creado a través de una de las
  API obsoletas (normalmente "PyUnicode_FromUnicode()") y solo tienen
  la representación "Py_UNICODE*"; Será necesario llamar a
  "PyUnicode_READY()" en ellos antes de llamar a cualquier otra 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
------------

Estos son los tipos básicos de objetos Unicode utilizados para la
implementación de Unicode en Python:

Py_UCS4
Py_UCS2
Py_UCS1

   Estos tipos son definiciones de tipo (*typedefs*) para los tipos
   'enteros sin signo' (*unsigned int*) lo suficientemente anchos como
   para contener caracteres de 32 bits, 16 bits y 8 bits,
   respectivamente. Cuando se trate con caracteres Unicode
   individuales, use "Py_UCS4".

   Nuevo en la versión 3.3.

Py_UNICODE

   Este es una definición de tipo (*typedef*) de "wchar_t", que es un
   tipo de 16 bits o de 32 bits dependiendo de la plataforma.

   Distinto en la versión 3.3: En versiones anteriores, este era un
   tipo de 16 bits o de 32 bits, dependiendo de si seleccionó una
   versión Unicode "estrecha" o "amplia" de Python en el momento de la
   compilación.

PyASCIIObject
PyCompactUnicodeObject
PyUnicodeObject

   Estos subtipos de "PyObject" representan un objeto Python Unicode.
   En casi todos los casos, no deben usarse directamente, ya que todas
   las funciones API que se ocupan de objetos Unicode toman y retornan
   punteros "PyObject".

   Nuevo en la versión 3.3.

PyTypeObject PyUnicode_Type

   Esta instancia de "PyTypeObject" representa el tipo Python Unicode.
   Está expuesto al código de Python como "str".

Las siguientes API son realmente macros de C y se pueden utilizar para
realizar comprobaciones rápidas y acceder a datos internos de solo
lectura de objetos Unicode:

int PyUnicode_Check(PyObject *o)

   Retorna verdadero si el objeto *o* es un objeto Unicode o una
   instancia de un subtipo Unicode.

int PyUnicode_CheckExact(PyObject *o)

   Retorna verdadero (*True*) si el objeto *o* es un objeto Unicode,
   pero no una instancia de un subtipo.

int PyUnicode_READY(PyObject *o)

   Asegura que el objeto de cadena de caracteres *o* esté en la
   representación "canónica". Esto es necesario antes de usar
   cualquiera de las macros de acceso que se describen a continuación.

   Retorna "0" en caso de éxito y "-1" con una excepción establecida
   en caso de error, que ocurre en particular si falla la asignación
   de memoria.

   Nuevo en la versión 3.3.

   Deprecated since version 3.10, will be removed in version 3.12:
   This API will be removed with "PyUnicode_FromUnicode()".

Py_ssize_t PyUnicode_GET_LENGTH(PyObject *o)

   Retorna la longitud de la cadena de caracteres Unicode, en puntos
   de código. *o* tiene que ser un objeto Unicode en la representación
   "canónica" (no marcada).

   Nuevo en la versión 3.3.

Py_UCS1* PyUnicode_1BYTE_DATA(PyObject *o)
Py_UCS2* PyUnicode_2BYTE_DATA(PyObject *o)
Py_UCS4* PyUnicode_4BYTE_DATA(PyObject *o)

   Retorna un puntero a la representación canónica emitida a los tipos
   enteros UCS1, UCS2 o UCS4 para el acceso directo a los caracteres.
   No se realizan verificaciones si la representación canónica tiene
   el tamaño de carácter correcto; use "PyUnicode_KIND()" para
   seleccionar el macro correcto. Asegúrese de que se haya llamado a
   "PyUnicode_READY()" antes de acceder a esto.

   Nuevo en la versión 3.3.

PyUnicode_WCHAR_KIND
PyUnicode_1BYTE_KIND
PyUnicode_2BYTE_KIND
PyUnicode_4BYTE_KIND

   Retorna los valores de la macro "PyUnicode_KIND()".

   Nuevo en la versión 3.3.

   Deprecated since version 3.10, will be removed in version 3.12:
   "PyUnicode_WCHAR_KIND" is deprecated.

int PyUnicode_KIND(PyObject *o)

   Retorna una de las constantes de tipo "PyUnicode" (ver arriba) que
   indican cuántos bytes por carácter utiliza este objeto Unicode para
   almacenar sus datos. *o* tiene que ser un objeto Unicode en la
   representación "canónica" (no marcada).

   Nuevo en la versión 3.3.

void* PyUnicode_DATA(PyObject *o)

   Retorna un puntero vacío al búfer Unicode sin formato. *o* tiene
   que ser un objeto Unicode en la representación "canónica" (no
   marcada).

   Nuevo en la versión 3.3.

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

   Escribe en una representación canónica *data* (como se obtiene con
   "PyUnicode_DATA()"). Esta macro no realiza ninguna comprobación de
   cordura y está diseñado para su uso en bucles. La persona que llama
   debe almacenar en caché el valor *kind* y el puntero *data* como se
   obtiene de otras llamadas de la macro. *index* es el índice en la
   cadena de caracteres (comienza en 0) y *value* es el nuevo valor
   del punto de código que debe escribirse en esa ubicación.

   Nuevo en la versión 3.3.

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

   Lee un punto de código de una representación canónica *data*
   (obtenido con "PyUnicode_DATA()"). No se realizan verificaciones ni
   llamadas preparadas.

   Nuevo en la versión 3.3.

Py_UCS4 PyUnicode_READ_CHAR(PyObject *o, Py_ssize_t index)

   Lee un carácter de un objeto Unicode *o*, que debe estar en la
   representación "canónica". Esto es menos eficiente que
   "PyUnicode_READ()" si realiza varias lecturas consecutivas.

   Nuevo en la versión 3.3.

PyUnicode_MAX_CHAR_VALUE(o)

   Retorna el punto de código máximo adecuado para crear otra cadena
   de caracteres basada en *o*, que debe estar en la representación
   "canónica". Esto siempre es una aproximación pero más eficiente que
   iterar sobre la cadena.

   Nuevo en la versión 3.3.

int PyUnicode_ClearFreeList()

   Borra la lista gratuita. Retorna el número total de artículos
   liberados.

Py_ssize_t PyUnicode_GET_SIZE(PyObject *o)

   Retorna el tamaño de la representación en desuso "Py_UNICODE", en
   unidades de código (esto incluye pares sustitutos como 2 unidades).
   *o* tiene que ser un objeto Unicode (no marcado).

   Deprecated since version 3.3, will be removed in version 3.12:
   Parte de la API Unicode de estilo antiguo, por favor migrar para
   usar "PyUnicode_GET_LENGTH()".

Py_ssize_t PyUnicode_GET_DATA_SIZE(PyObject *o)

   Retorna el tamaño de la representación en desuso "Py_UNICODE" en
   bytes. *o* tiene que ser un objeto Unicode (no marcado).

   Deprecated since version 3.3, will be removed in version 3.12:
   Parte de la API Unicode de estilo antiguo, por favor migrar para
   usar "PyUnicode_GET_LENGTH()".

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

   Retorna un puntero a una representación "Py_UNICODE" del objeto. El
   búfer retornado siempre termina con un punto de código nulo
   adicional. También puede contener puntos de código nulo
   incrustados, lo que provocaría que la cadena de caracteres se
   truncara cuando se usara en la mayoría de las funciones de C. La
   forma "AS_DATA" arroja el puntero a "const char *". El argumento
   *o* tiene que ser un objeto Unicode (no marcado).

   Distinto en la versión 3.3: Esta macro ahora es ineficiente, porque
   en muchos casos la representación "Py_UNICODE" no existe y necesita
   ser creada, y puede fallar (retornar "NULL" con un conjunto de
   excepciones). Intente portar el código para usar las nuevas macros
   "PyUnicode_nBYTE_DATA()" o use "PyUnicode_WRITE()" o
   "PyUnicode_READ()".

   Deprecated since version 3.3, will be removed in version 3.12:
   Parte de la antigua API Unicode, por favor migre para usar la
   familia de macros "PyUnicode_nBYTE_DATA()".


Propiedades de caracteres Unicode
---------------------------------

Unicode proporciona muchas propiedades de caracteres diferentes. Los
que se necesitan con mayor frecuencia están disponibles a través de
estas macros que se asignan a las funciones de C según la
configuración de Python.

int Py_UNICODE_ISSPACE(Py_UNICODE ch)

   Retorna "1" o "0" dependiendo de si *ch* es un carácter de espacio
   en blanco.

int Py_UNICODE_ISLOWER(Py_UNICODE ch)

   Retorna "1" o "0" dependiendo de si *ch* es un carácter en
   minúscula.

int Py_UNICODE_ISUPPER(Py_UNICODE ch)

   Retorna "1" o "0" dependiendo de si *ch* es un carácter en
   mayúscula.

int Py_UNICODE_ISTITLE(Py_UNICODE ch)

   Retorna "1" o "0" dependiendo de si *ch* es un carácter en caso de
   título (*titlecase*).

int Py_UNICODE_ISLINEBREAK(Py_UNICODE ch)

   Retorna "1" o "0" dependiendo de si *ch* es un carácter de salto de
   línea.

int Py_UNICODE_ISDECIMAL(Py_UNICODE ch)

   Retorna "1" o "0" dependiendo de si *ch* es un carácter decimal o
   no.

int Py_UNICODE_ISDIGIT(Py_UNICODE ch)

   Retorna "1" o "0" dependiendo de si *ch* es un carácter de dígitos.

int Py_UNICODE_ISNUMERIC(Py_UNICODE ch)

   Retorna "1" o "0" dependiendo de si *ch* es un carácter numérico.

int Py_UNICODE_ISALPHA(Py_UNICODE ch)

   Retorna "1" o "0" dependiendo de si *ch* es un carácter alfabético.

int Py_UNICODE_ISALNUM(Py_UNICODE ch)

   Retorna "1" o "0" dependiendo de si *ch* es un carácter
   alfanumérico.

int Py_UNICODE_ISPRINTABLE(Py_UNICODE ch)

   Retorna "1" o "0" dependiendo de si *ch* es un carácter imprimible.
   Los caracteres no imprimibles son aquellos definidos en la base de
   datos de caracteres Unicode como "Otro" o "Separador", excepto el
   espacio ASCII (0x20) que se considera imprimible. (Tenga en cuenta
   que los caracteres imprimibles en este contexto son aquellos a los
   que no se debe escapar cuando "repr()" se invoca en una cadena de
   caracteres. No tiene relación con el manejo de cadenas de
   caracteres escritas en "sys.stdout" o "sys.stderr".)

Estas API se pueden usar para conversiones caracteres rápidas y
directos:

Py_UNICODE Py_UNICODE_TOLOWER(Py_UNICODE ch)

   Retorna el carácter *ch* convertido a minúsculas.

   Obsoleto desde la versión 3.3: Esta función utiliza conversiones
   simples.

Py_UNICODE Py_UNICODE_TOUPPER(Py_UNICODE ch)

   Retorna el carácter *ch* convertido a mayúsculas.

   Obsoleto desde la versión 3.3: Esta función utiliza conversiones
   simples.

Py_UNICODE Py_UNICODE_TOTITLE(Py_UNICODE ch)

   Retorna el carácter *ch* convertido a formato de título
   (*titlecase*).

   Obsoleto desde la versión 3.3: Esta función utiliza conversiones
   simples.

int Py_UNICODE_TODECIMAL(Py_UNICODE ch)

   Retorna el carácter *ch* convertido a un entero positivo decimal.
   Retorna "-1" si esto no es posible. Esta macro no genera
   excepciones.

int Py_UNICODE_TODIGIT(Py_UNICODE ch)

   Retorna el carácter *ch* convertido a un entero de un solo dígito.
   Retorna "-1" si esto no es posible. Esta macro no genera
   excepciones.

double Py_UNICODE_TONUMERIC(Py_UNICODE ch)

   Retorna el carácter *ch* convertido a doble. retorne "-1.0" si esto
   no es posible. Esta macro no genera excepciones.

Estas API se pueden usar para trabajar con sustitutos:

Py_UNICODE_IS_SURROGATE(ch)

   Comprueba si *ch* es un sustituto ("0xD800 <= ch <= 0xDFFF").

Py_UNICODE_IS_HIGH_SURROGATE(ch)

   Comprueba si *ch* es un sustituto alto ("0xD800 <= ch <= 0xDFFF").

Py_UNICODE_IS_LOW_SURROGATE(ch)

   Comprueba si *ch* es un sustituto bajo ("0xD800 <= ch <= 0xDFFF").

Py_UNICODE_JOIN_SURROGATES(high, low)

   Une dos caracteres sustitutos y retorna un solo valor Py_UCS4.
   *high* y *low* son respectivamente los sustitutos iniciales y
   finales en un par sustituto.


Creando y accediendo a cadenas de caracteres Unicode
----------------------------------------------------

Para crear objetos Unicode y acceder a sus propiedades de secuencia
básicas, use estas API:

PyObject* PyUnicode_New(Py_ssize_t size, Py_UCS4 maxchar)
    *Return value: New reference.*

   Crea un nuevo objeto Unicode. *maxchar* debe ser el punto de código
   máximo que se colocará en la cadena de caracteres. Como una
   aproximación, se puede redondear al valor más cercano en la
   secuencia 127, 255, 65535, 1114111.

   Esta es la forma recomendada de asignar un nuevo objeto Unicode.
   Los objetos creados con esta función no se pueden redimensionar.

   Nuevo en la versión 3.3.

PyObject* PyUnicode_FromKindAndData(int kind, const void *buffer, Py_ssize_t size)
    *Return value: New reference.*

   Crea un nuevo objeto Unicode con el tipo *kind* dado (los valores
   posibles son "PyUnicode_1BYTE_KIND" etc., según lo retornado por
   "PyUnicode_KIND()"). El *búfer* debe apuntar a un vector (*array*)
   de *tamaño* unidades de 1, 2 o 4 bytes por carácter, según el tipo.

   Nuevo en la versión 3.3.

PyObject* PyUnicode_FromStringAndSize(const char *u, Py_ssize_t size)
    *Return value: New reference.*

   Crea un objeto Unicode desde el búfer de caracteres *u*. Los bytes
   se interpretarán como codificados en UTF-8. El búfer se copia en el
   nuevo objeto. Si el búfer no es "NULL", el valor de retorno podría
   ser un objeto compartido, es decir, no se permite la modificación
   de los datos.

   If *u* 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 *u)
    *Return value: New reference.*

   Crea un objeto Unicode a partir de un búfer *u* de caracteres
   terminado en nulo y codificado en UTF-8.

PyObject* PyUnicode_FromFormat(const char *format, ...)
    *Return value: New reference.*

   Toma una cadena de caracteres *format* con el estilo de "printf()"
   en C y un número variable de argumentos, calcula el tamaño de la
   cadena Python Unicode resultante y retorna una cadena de caracteres
   con los valores formateados. Los argumentos variables deben ser
   tipos de C y deben corresponder exactamente a los caracteres de
   formato en la cadena de caracteres *format* codificada en ASCII. Se
   permiten los siguientes caracteres de formato:

   +---------------------+-----------------------+------------------------------------+
   | Formatear           | Tipo                  | Comentario                         |
   | caracteres          |                       |                                    |
   |=====================|=======================|====================================|
   | "%%"                | *n/a*                 | El carácter literal %.             |
   +---------------------+-----------------------+------------------------------------+
   | "%c"                | int                   | Un solo carácter, representado     |
   |                     |                       | como un entero (*int*) de C.       |
   +---------------------+-----------------------+------------------------------------+
   | "%d"                | int                   | Equivalente a "printf("%d")". [1]  |
   +---------------------+-----------------------+------------------------------------+
   | "%u"                | unsigned int          | Equivalente a "printf("%u")". [1]  |
   +---------------------+-----------------------+------------------------------------+
   | "%ld"               | long                  | Equivalente a "printf("%ld")". [1] |
   +---------------------+-----------------------+------------------------------------+
   | "%li"               | long                  | Equivalente a "printf("%li")". [1] |
   +---------------------+-----------------------+------------------------------------+
   | "%lu"               | unsigned long         | Equivalente a "printf("%lu")". [1] |
   +---------------------+-----------------------+------------------------------------+
   | "%lld"              | long long             | Equivalente a "printf("%lld")".    |
   |                     |                       | [1]                                |
   +---------------------+-----------------------+------------------------------------+
   | "%lli"              | long long             | Equivalente a "printf("%lli")".    |
   |                     |                       | [1]                                |
   +---------------------+-----------------------+------------------------------------+
   | "%llu"              | unsigned long long    | Equivalente a "printf("%llu")".    |
   |                     |                       | [1]                                |
   +---------------------+-----------------------+------------------------------------+
   | "%zd"               | Py_ssize_t            | Equivalente a "printf("%zd")". [1] |
   +---------------------+-----------------------+------------------------------------+
   | "%zi"               | Py_ssize_t            | Equivalente a "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*           | Un arreglo de caracteres de C      |
   |                     |                       | terminada en nulo.                 |
   +---------------------+-----------------------+------------------------------------+
   | "%p"                | const void*           | La representación hexadecimal de   |
   |                     |                       | un puntero en C. Principalmente    |
   |                     |                       | equivalente a "printf("%p")"       |
   |                     |                       | excepto que se garantiza que       |
   |                     |                       | comience con el literal "0x",      |
   |                     |                       | independiente de lo que produzca   |
   |                     |                       | el "printf" de la plataforma.      |
   +---------------------+-----------------------+------------------------------------+
   | "%A"                | PyObject*             | El resultado de llamar "ascii()".  |
   +---------------------+-----------------------+------------------------------------+
   | "%U"                | PyObject*             | Un objeto Unicode.                 |
   +---------------------+-----------------------+------------------------------------+
   | "%V"                | PyObject*, const      | Un objeto Unicode (que puede ser   |
   |                     | char*                 | "NULL") y un arreglo de caracteres |
   |                     |                       | de C terminada en nulo como        |
   |                     |                       | segundo parámetro (que se          |
   |                     |                       | utilizará, si el primer parámetro  |
   |                     |                       | es "NULL").                        |
   +---------------------+-----------------------+------------------------------------+
   | "%S"                | PyObject*             | El resultado de llamar             |
   |                     |                       | "PyObject_Str()".                  |
   +---------------------+-----------------------+------------------------------------+
   | "%R"                | PyObject*             | El resultado de llamar             |
   |                     |                       | "PyObject_Repr()".                 |
   +---------------------+-----------------------+------------------------------------+

   Un carácter de formato no reconocido hace que todo el resto de la
   cadena de formato se copie tal cual a la cadena de resultado y se
   descartan los argumentos adicionales.

   Nota:

     La unidad del formateador de ancho es el número de caracteres en
     lugar de bytes. La unidad del formateador de precisión es la
     cantidad de bytes para ""%s"" y ""%V" `` (si el argumento
     ``PyObject*" es "NULL"), y una cantidad de caracteres para
     ""%A"", ""%U"", ""%S"", ""%R"" y ""%V"" (si el argumento
     "PyObject*" no es "NULL").

   [1] Para especificadores de enteros *(d, u, ld, li, lu, lld, lli,
       llu, zd, zi, zu, i, x)*: el indicador de conversión 0 tiene
       efecto incluso cuando se proporciona una precisión.

   Distinto en la versión 3.2: Soporte agregado para ""%lld"" y
   ""%llu"".

   Distinto en la versión 3.3: Soporte agregado para ""%li"", ""%lli""
   y ""%zi"".

   Distinto en la versión 3.4: Soporte agregado para formateadores de
   anchura y precisión para ""%s"", ""%A"", ""%U"", ""%V"", ""%S"",
   ""%R"".

PyObject* PyUnicode_FromFormatV(const char *format, va_list vargs)
    *Return value: New reference.*

   Idéntico a "PyUnicode_FromFormat()" excepto que toma exactamente
   dos argumentos.

PyObject* PyUnicode_FromEncodedObject(PyObject *obj, const char *encoding, const char *errors)
    *Return value: New reference.*

   Decodifica un objeto codificado *obj* en un objeto Unicode.

   "bytes", "bytearray" y otros *los objetos similares a bytes* se
   decodifican de acuerdo con el *encoding* dado y utilizan el manejo
   de errores definido por *errors*. Ambos pueden ser "NULL" para que
   la interfaz use los valores predeterminados (ver Códecs
   incorporados para más detalles).

   Todos los demás objetos, incluidos los objetos Unicode, hacen que
   se establezca un "TypeError".

   La API retorna "NULL" si hubo un error. La entidad que hace la
   llamadas es la responsable de desreferenciar los objetos
   retornados.

Py_ssize_t PyUnicode_GetLength(PyObject *unicode)

   Retorna la longitud del objeto Unicode, en puntos de código.

   Nuevo en la versión 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)

   Copia caracteres de un objeto Unicode en otro. Esta función realiza
   la conversión de caracteres cuando es necesario y recurre a
   "memcpy()" si es posible. Retorna "-1" y establece una excepción en
   caso de error; de lo contrario, retorna el número de caracteres
   copiados.

   Nuevo en la versión 3.3.

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

   Rellena una cadena con un carácter: escriba *fill_char* en
   "unicode[inicio:inicio+longitud]".

   Falla si *fill_char* es más grande que el carácter máximo de la
   cadena, o si la cadena tiene más de 1 referencia.

   Retorna el número de caracteres escritos o retorna "-1" y genera
   una excepción en caso de error.

   Nuevo en la versión 3.3.

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

   Escribe un carácter en una cadena de caracteres. La cadena debe
   haberse creado a través de "PyUnicode_New()". Dado que se supone
   que las cadenas de caracteres Unicode son inmutables, la cadena no
   debe compartirse o no se ha cifrado todavía.

   Esta función comprueba que *unicode* es un objeto Unicode, que el
   índice no está fuera de los límites y que el objeto se puede
   modificar de forma segura (es decir, si su número de referencia es
   uno).

   Nuevo en la versión 3.3.

Py_UCS4 PyUnicode_ReadChar(PyObject *unicode, Py_ssize_t index)

   Lee un carácter de una cadena de caracteres. Esta función verifica
   que *unicode* es un objeto Unicode y que el índice no está fuera de
   límites, en contraste con la versión de macro
   "PyUnicode_READ_CHAR()".

   Nuevo en la versión 3.3.

PyObject* PyUnicode_Substring(PyObject *str, Py_ssize_t start, Py_ssize_t end)
    *Return value: New reference.*

   Retorna una subcadena de caracteres de *str*, desde el índice de
   caracteres *start* (incluido) al índice de caracteres *end*
   (excluido). Los índices negativos no son compatibles.

   Nuevo en la versión 3.3.

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

   Copia la cadena de caracteres *u* en un búfer UCS4, incluido un
   carácter nulo, si *copy_null* está configurado. Retorna "NULL" y
   establece una excepción en caso de error (en particular, a
   "SystemError" si *buflen* es menor que la longitud de *u*).
   *buffer* se retorna en caso de éxito.

   Nuevo en la versión 3.3.

Py_UCS4* PyUnicode_AsUCS4Copy(PyObject *u)

   Copia la cadena de caracteres *u* en un nuevo búfer UCS4 que se
   asigna usando "PyMem_Malloc()". Si esto falla, se retorna "NULL"
   con un "MemoryError" establecido. El búfer retornado siempre tiene
   un punto de código nulo adicional agregado.

   Nuevo en la versión 3.3.


APIs de Py_UNICODE deprecadas
-----------------------------

Deprecated since version 3.3, will be removed in version 3.12.

Estas funciones API están en desuso con la implementación de **PEP
393**. Los módulos de extensión pueden continuar usándolos, ya que no
se eliminarán en Python 3.x, pero deben ser conscientes de que su uso
ahora puede causar problemas de rendimiento y memoria.

PyObject* PyUnicode_FromUnicode(const Py_UNICODE *u, Py_ssize_t size)
    *Return value: New reference.*

   Crea un objeto Unicode desde el búfer Py_UNICODE *u* del tamaño
   dado. *u* puede ser "NULL", lo que hace que el contenido no esté
   definido. Es responsabilidad del usuario completar los datos
   necesarios. El búfer se copia en el nuevo objeto.

   Si el búfer no es "NULL", el valor de retorno podría ser un objeto
   compartido. Por lo tanto, la modificación del objeto Unicode
   resultante solo se permite cuando *u* es "NULL".

   Si el búfer es "NULL", se debe llamar a "PyUnicode_READY()" una vez
   que se haya llenado el contenido de la cadena de caracteres antes
   de usar cualquiera de las macros de acceso, como
   "PyUnicode_KIND()".

   Deprecated since version 3.3, will be removed in version 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)

   Retorna un puntero de solo lectura al búfer "Py_UNICODE" interno
   del objeto Unicode, o "NULL" en caso de error. Esto creará la
   representación "Py_UNICODE*" del objeto si aún no está disponible.
   El búfer siempre termina con un punto de código nulo adicional.
   Tenga en cuenta que la cadena de caracteres resultante "Py_UNICODE"
   también puede contener puntos de código nulo incrustados, lo que
   provocaría que la cadena se truncara cuando se usara en la mayoría
   de las funciones de C.

   Deprecated since version 3.3, will be removed in version 3.12: Part
   of the old-style Unicode API, please migrate to using
   "PyUnicode_AsUCS4()", "PyUnicode_AsWideChar()",
   "PyUnicode_ReadChar()" or similar new APIs.

   Deprecated since version 3.3, will be removed in version 3.10.

PyObject* PyUnicode_TransformDecimalToASCII(Py_UNICODE *s, Py_ssize_t size)
    *Return value: New reference.*

   Crea un objeto Unicode reemplazando todos los dígitos decimales en
   el búfer "Py_UNICODE" del *size* dado por dígitos ASCII 0--9 de
   acuerdo con su valor decimal. Retorna "NULL" si ocurre una
   excepción.

   Deprecated since version 3.3, will be removed in version 3.11: Part
   of the old-style "Py_UNICODE" API; please migrate to using
   "Py_UNICODE_TODECIMAL()".

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

   Como "PyUnicode_AsUnicode()", pero también guarda la longitud del
   arreglo "Py_UNICODE()" (excluyendo el terminador nulo adicional) en
   *size*. Tenga en cuenta que la cadena de caracteres resultante
   "Py_UNICODE*" puede contener puntos de código nulo incrustados, lo
   que provocaría que la cadena se truncara cuando se usara en la
   mayoría de las funciones de C.

   Nuevo en la versión 3.3.

   Deprecated since version 3.3, will be removed in version 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_AsUnicodeCopy(PyObject *unicode)

   Crea una copia de una cadena de caracteres Unicode que termina con
   un punto de código nulo. Retorna "NULL" y genera una excepción
   "MemoryError" en caso de fallo de asignación de memoria; de lo
   contrario, retorna un nuevo búfer asignado (use "PyMem_Free()" para
   liberar el búfer). Tenga en cuenta que la cadena de caracteres
   resultante "Py_UNICODE*" puede contener puntos de código nulo
   incrustados, lo que provocaría que la cadena se truncara cuando se
   usara en la mayoría de las funciones de C.

   Nuevo en la versión 3.2.

   Por favor migrar para usar "PyUnicode_AsUCS4Copy()" o API nuevas
   similares.

Py_ssize_t PyUnicode_GetSize(PyObject *unicode)

   Retorna el tamaño de la representación en desuso "Py_UNICODE", en
   unidades de código (esto incluye pares sustitutos como 2 unidades).

   Deprecated since version 3.3, will be removed in version 3.12:
   Parte de la API Unicode de estilo antiguo, por favor migrar para
   usar "PyUnicode_GET_LENGTH()".

PyObject* PyUnicode_FromObject(PyObject *obj)
    *Return value: New reference.*

   Copia una instancia de un subtipo Unicode a un nuevo objeto Unicode
   verdadero si es necesario. Si *obj* ya es un verdadero objeto
   Unicode (no un subtipo), retorna la referencia con un recuento
   incrementado.

   Los objetos que no sean Unicode o sus subtipos causarán un
   "TypeError".


Codificación regional
---------------------

La codificación local actual se puede utilizar para decodificar texto
del sistema operativo.

PyObject* PyUnicode_DecodeLocaleAndSize(const char *str, Py_ssize_t len, const char *errors)
    *Return value: New reference.*

   Decodifica una cadena de caracteres UTF-8 en Android y VxWorks, o
   de la codificación de configuración regional actual en otras
   plataformas. Los manejadores de errores admitidos son ""estricto""
   y ""subrogateescape"" (**PEP 383**). El decodificador usa el
   controlador de errores ""estricto"" si *errors* es``NULL``. *str*
   debe terminar con un carácter nulo pero no puede contener
   caracteres nulos incrustados.

   Utilice "PyUnicode_DecodeFSDefaultAndSize()" para decodificar una
   cadena de "Py_FileSystemDefaultEncoding" (la codificación de la
   configuración regional leída al iniciar Python).

   Esta función ignora el modo Python UTF-8.

   Ver también: La función "Py_DecodeLocale()".

   Nuevo en la versión 3.3.

   Distinto en la versión 3.7: La función ahora también usa la
   codificación de configuración regional actual para el controlador
   de errores "subrogateescape", excepto en Android. Anteriormente,
   "Py_DecodeLocale()" se usaba para el "subrogateescape", y la
   codificación local actual se usaba para "estricto".

PyObject* PyUnicode_DecodeLocale(const char *str, const char *errors)
    *Return value: New reference.*

   Similar a "PyUnicode_DecodeLocaleAndSize()", pero calcula la
   longitud de la cadena de caracteres usando "strlen()".

   Nuevo en la versión 3.3.

PyObject* PyUnicode_EncodeLocale(PyObject *unicode, const char *errors)
    *Return value: New reference.*

   Codifica un objeto Unicode UTF-8 en Android y VxWorks, o en la
   codificación local actual en otras plataformas. Los manejadores de
   errores admitidos son ""estricto" `` y ``"subrogateescape"" (**PEP
   383**). El codificador utiliza el controlador de errores
   ""estricto"" si *errors* es "NULL". Retorna un objeto "bytes".
   *unicode* no puede contener caracteres nulos incrustados.

   Utilice "PyUnicode_EncodeFSDefault()" para codificar una cadena de
   caracteres en "Py_FileSystemDefaultEncoding" (la codificación de la
   configuración regional leída al iniciar Python).

   Esta función ignora el modo Python UTF-8.

   Ver también: La función "Py_EncodeLocale()".

   Nuevo en la versión 3.3.

   Distinto en la versión 3.7: La función ahora también usa la
   codificación de configuración regional actual para el controlador
   de errores "subrogateescape", excepto en Android. Anteriormente,
   "Py_EncodeLocale()" se usaba para el "subrogateescape", y la
   codificación local actual se usaba para "estricto".


Codificación del sistema de archivos
------------------------------------

Para codificar y decodificar nombres de archivo y otras cadenas de
caracteres de entorno, "Py_FileSystemDefaultEncoding" debe usarse como
codificación, y "Py_FileSystemDefaultEncodeErrors" debe usarse como
controlador de errores (**PEP 383** y **PEP 529**). Para codificar
nombres de archivo a "bytes" durante el análisis de argumentos, se
debe usar el convertidor ""O&"", pasando "PyUnicode_FSConverter()"
como la función de conversión:

int PyUnicode_FSConverter(PyObject* obj, void* result)

   Convertidor *ParseTuple* : codificar objetos "str" -- obtenidos
   directamente o mediante la interfaz "os.PathLike" -- a "bytes"
   usando "PyUnicode_EncodeFSDefault()"; los objetos "bytes" se emiten
   tal cual. *result* debe ser un "PyBytesObject*" que debe liberarse
   cuando ya no se use.

   Nuevo en la versión 3.1.

   Distinto en la versión 3.6: Acepta un objeto similar a una ruta
   (*path-like object*).

Para decodificar nombres de archivo a "str" durante el análisis de
argumentos, se debe usar el convertidor ""O&"", pasando
"PyUnicode_FSDecoder()" como la función de conversión:

int PyUnicode_FSDecoder(PyObject* obj, void* result)

   Conversor "ParseTuple": decodifica objetos "bytes" -- obtenidos
   directa o indirectamente a través de la interfaz "os.PathLike" -- a
   "str" usando "PyUnicode_DecodeFSDefaultAndSize()"; los objetos
   "str" se generan tal cual. *result* debe ser "PyUnicodeObject*" que
   debe liberarse cuando ya no se use.

   Nuevo en la versión 3.2.

   Distinto en la versión 3.6: Acepta un objeto similar a una ruta
   (*path-like object*).

PyObject* PyUnicode_DecodeFSDefaultAndSize(const char *s, Py_ssize_t size)
    *Return value: New reference.*

   Decodifica una cadena usando "Py_FileSystemDefaultEncoding" y el
   controlador de errores "Py_FileSystemDefaultEncodeErrors".

   Si "Py_FileSystemDefaultEncoding" no está configurado, recurre a la
   codificación de configuración regional.

   "Py_FileSystemDefaultEncoding" se inicializa al inicio desde la
   codificación local y no se puede modificar más tarde. Si se
   necesita decodificar una cadena de caracteres de la codificación
   local actual, utilice "PyUnicode_DecodeLocaleAndSize()".

   Ver también: La función "Py_DecodeLocale()".

   Distinto en la versión 3.6: Utilice el controlador de errores
   "Py_FileSystemDefaultEncodeErrors".

PyObject* PyUnicode_DecodeFSDefault(const char *s)
    *Return value: New reference.*

   Decodifique una cadena terminada en nulo usando
   "Py_FileSystemDefaultEncoding" y el
   "Py_FileSystemDefaultEncodeErrors" controlador de errores.

   Si "Py_FileSystemDefaultEncoding" no está configurado, recurre a la
   codificación de configuración regional.

   Utilice "PyUnicode_DecodeFSDefaultAndSize()" si conoce la longitud
   de la cadena.

   Distinto en la versión 3.6: Utilice el controlador de errores
   "Py_FileSystemDefaultEncodeErrors".

PyObject* PyUnicode_EncodeFSDefault(PyObject *unicode)
    *Return value: New reference.*

   Codifica un objeto Unicode para "Py_FileSystemDefaultEncoding" con
   el manejador de errores "Py_FileSystemDefaultEncodeErrors", y
   retorna "bytes". Tenga en cuenta que el objeto resultante "bytes"
   puede contener bytes nulos.

   Si "Py_FileSystemDefaultEncoding" no está configurado, recurre a la
   codificación de configuración regional.

   "Py_FileSystemDefaultEncoding" se inicializa al inicio desde la
   codificación local y no se puede modificar más tarde. Si necesita
   codificar una cadena a la codificación local actual, utilice
   "PyUnicode_EncodeLocale()".

   Ver también: La función "Py_EncodeLocale()".

   Nuevo en la versión 3.2.

   Distinto en la versión 3.6: Utilice el controlador de errores
   "Py_FileSystemDefaultEncodeErrors".


Soporte wchar_t
---------------

soporte "wchar_t" para plataformas que lo soportan:

PyObject* PyUnicode_FromWideChar(const wchar_t *w, Py_ssize_t size)
    *Return value: New reference.*

   Crea un objeto Unicode a partir del búfer "wchar_t" *w* del tamaño
   *size* dado. Pasar "-1" como *size* indica que la función debe
   calcular la longitud, usando "wcslen". Retorna "NULL" en caso de
   falla.

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

   Copia el contenido del objeto Unicode en el búfer "wchar_t" *w*. A
   lo sumo *size* se copian los caracteres "wchar_t" (excluyendo un
   posible carácter de terminación nulo final). Retorna el número de
   caracteres "wchar_t" copiados o "-1" en caso de error. Tenga en
   cuenta que la cadena resultante "wchar_t*" puede o no tener
   terminación nula. Es responsabilidad de la persona que llama
   asegurarse de que la cadena "wchar_t*" tenga una terminación nula
   en caso de que la aplicación lo requiera. Además, tenga en cuenta
   que la cadena "wchar_t*" podría contener caracteres nulos, lo que
   provocaría que la cadena se truncara cuando se usara con la mayoría
   de las funciones de C.

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

   Convierte el objeto Unicode en una cadena de caracteres ancha. La
   cadena de salida siempre termina con un carácter nulo. Si *size* no
   es "NULL", escribe el número de caracteres anchos (excluyendo el
   carácter de terminación nulo final) en **size*. Tenga en cuenta que
   la cadena resultante "wchar_t" podría contener caracteres nulos, lo
   que provocaría que la cadena se truncara cuando se usara con la
   mayoría de las funciones de C. Si *size* es "NULL" y la cadena
   "wchar_t*" contiene caracteres nulos un "ValueError" aparece.

   Retorna un búfer asignado por "PyMem_Alloc()" (utilice
   "PyMem_Free()" para liberarlo) en caso de éxito. En caso de error,
   retorna "NULL" y **size* no está definido. Provoca un "MemoryError"
   si falla la asignación de memoria.

   Nuevo en la versión 3.2.

   Distinto en la versión 3.7: Provoca un "ValueError" si *size* es
   "NULL" y la cadena "wchar_t*" contiene caracteres nulos.


Códecs incorporados
===================

Python proporciona un conjunto de códecs integrados que están escritos
en C para mayor velocidad. Todos estos códecs se pueden usar
directamente a través de las siguientes funciones.

Muchas de las siguientes API toman dos argumentos de *encoding* y
*errors*, y tienen la misma semántica que las del constructor de
objetos de cadena incorporado "str()".

Establecer la codificación en "NULL" hace que se use la codificación
predeterminada, que es ASCII. Las llamadas al sistema de archivos
deben usar "PyUnicode_FSConverter()" para codificar nombres de
archivos. Esto utiliza la variable "Py_FileSystemDefaultEncoding"
internamente. Esta variable debe tratarse como de solo lectura: en
algunos sistemas, será un puntero a una cadena de caracteres estática,
en otros, cambiará en tiempo de ejecución (como cuando la aplicación
invoca *setlocale*).

El manejo de errores se establece mediante *errors* que también pueden
establecerse en "NULL", lo que significa usar el manejo predeterminado
definido para el códec. El manejo de errores predeterminado para todos
los códecs integrados es "estricto" (se lanza "ValueError").

Todos los códecs usan una interfaz similar. Solo la desviación de las
siguientes genéricas se documenta por simplicidad.


Códecs genéricos
----------------

Estas son las APIs de códecs genéricos:

PyObject* PyUnicode_Decode(const char *s, Py_ssize_t size, const char *encoding, const char *errors)
    *Return value: New reference.*

   Crea un objeto Unicode decodificando *size* bytes de la cadena
   codificada *s*. *encoding* y *errors* tienen el mismo significado
   que los parámetros del mismo nombre en la función incorporada
   "str()". El códec que se utilizará se busca utilizando el registro
   de códec Python. Retorna "NULL" si el códec provocó una excepción.

PyObject* PyUnicode_AsEncodedString(PyObject *unicode, const char *encoding, const char *errors)
    *Return value: New reference.*

   Codifica un objeto Unicode y retorna el resultado como un objeto de
   bytes de Python. *encoding* y *errors* tienen el mismo significado
   que los parámetros del mismo nombre en el método Unicode
   "encode()". El códec que se utilizará se busca utilizando el
   registro de códec Python. Retorna "NULL" si el códec provocó una
   excepción.

PyObject* PyUnicode_Encode(const Py_UNICODE *s, Py_ssize_t size, const char *encoding, const char *errors)
    *Return value: New reference.*

   Codifica el búfer "Py_UNICODE" *s* del tamaño *size* dado y retorna
   un objeto de bytes de Python. *encoding* y *errors* tienen el mismo
   significado que los parámetros del mismo nombre en el método
   Unicode "encode()". El códec que se utilizará se busca utilizando
   el registro de códec Python. Retorna "NULL" si el códec provocó una
   excepción.

   Deprecated since version 3.3, will be removed in version 3.11:
   Parte del viejo estilo de la API "Py_UNICODE"; por favor migrar
   para usar "PyUnicode_AsEncodedString()".


Códecs UTF-8
------------

Estas son las APIs del códec UTF-8:

PyObject* PyUnicode_DecodeUTF8(const char *s, Py_ssize_t size, const char *errors)
    *Return value: New reference.*

   Crea un objeto Unicode decodificando *size* bytes de la cadena
   codificada UTF-8 *s*. Retorna "NULL" si el códec provocó una
   excepción.

PyObject* PyUnicode_DecodeUTF8Stateful(const char *s, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
    *Return value: New reference.*

   Si *consumed* es "NULL", se comporta como "PyUnicode_DecodeUTF8()".
   Si *consumed* no es "NULL", las secuencias de bytes UTF-8
   incompletas no se tratarán como un error. Esos bytes no serán
   decodificados y la cantidad de bytes que han sido decodificados se
   almacenará en *consumed*.

PyObject* PyUnicode_AsUTF8String(PyObject *unicode)
    *Return value: New reference.*

   Codifica un objeto Unicode usando UTF-8 y retorna el resultado como
   un objeto de bytes de Python. El manejo de errores es "estricto".
   Retorna "NULL" si el códec provocó una excepción.

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

   Retorna un puntero a la codificación UTF-8 del objeto Unicode y
   almacena el tamaño de la representación codificada (en bytes) en
   *size*. El argumento *size* puede ser "NULL"; en este caso no se
   almacenará el tamaño. El búfer retornado siempre tiene un byte nulo
   adicional agregado (no incluido en *size*), independientemente de
   si hay otros puntos de código nulo.

   En caso de error, se retorna "NULL" con un conjunto de excepciones
   y no se almacena *size*.

   Esto almacena en caché la representación UTF-8 de la cadena en el
   objeto Unicode, y las llamadas posteriores retornarán un puntero al
   mismo búfer. La persona que llama no es responsable de desasignar
   el búfer.

   Nuevo en la versión 3.3.

   Distinto en la versión 3.7: El tipo de retorno ahora es "const char
   *" en lugar de "char *".

const char* PyUnicode_AsUTF8(PyObject *unicode)

   Como "PyUnicode_AsUTF8AndSize()", pero no almacena el tamaño.

   Nuevo en la versión 3.3.

   Distinto en la versión 3.7: El tipo de retorno ahora es "const char
   *" en lugar de "char *".

PyObject* PyUnicode_EncodeUTF8(const Py_UNICODE *s, Py_ssize_t size, const char *errors)
    *Return value: New reference.*

   Codifica el búfer "Py_UNICODE" *s* del tamaño *size* dado usando
   UTF-8 y retorna un objeto de bytes de Python. Retorna "NULL" si el
   códec provocó una excepción.

   Deprecated since version 3.3, will be removed in version 3.11:
   Parte del viejo estilo de la API "Py_UNICODE"; por favor migrar
   para usar "PyUnicode_AsUTF8String()", "PyUnicode_AsUTF8AndSize()" o
   "PyUnicode_AsEncodedString()".


Códecs UTF-32
-------------

Estas son las APIs de códecs para UTF-32:

PyObject* PyUnicode_DecodeUTF32(const char *s, Py_ssize_t size, const char *errors, int *byteorder)
    *Return value: New reference.*

   Decodifica *size* bytes de una cadena de búfer codificada UTF-32 y
   retorna el objeto Unicode correspondiente. *errors* (si no es
   "NULL") define el manejo de errores. Su valor predeterminado es
   "estricto".

   Si *byteorder* no es "NULL", el decodificador comienza a
   decodificar utilizando el orden de bytes dado:

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

   Si "*byteorder" es cero, y los primeros cuatro bytes de los datos
   de entrada son una marca de orden de bytes (BOM), el decodificador
   cambia a este orden de bytes y la BOM no se copia en la cadena de
   caracteres Unicode resultante. Si "*byteorder" es "-1" o "1",
   cualquier marca de orden de bytes se copia en la salida.

   Una vez completado, **byteorder* se establece en el orden de bytes
   actual al final de los datos de entrada.

   Si *byteorder* es "NULL", el códec se inicia en modo de orden
   nativo.

   Retorna "NULL" si el códec provocó una excepción.

PyObject* PyUnicode_DecodeUTF32Stateful(const char *s, Py_ssize_t size, const char *errors, int *byteorder, Py_ssize_t *consumed)
    *Return value: New reference.*

   Si *consumed* es "NULL", se comporta como
   "PyUnicode_DecodeUTF32()". Si *consumed* no es "NULL",
   "PyUnicode_DecodeUTF32Stateful()" no tratará las secuencias de
   bytes UTF-32 incompletas finales (como un número de bytes no
   divisible por cuatro) como un error. Esos bytes no serán
   decodificados y la cantidad de bytes que han sido decodificados se
   almacenará en *consumed*.

PyObject* PyUnicode_AsUTF32String(PyObject *unicode)
    *Return value: New reference.*

   Retorna una cadena de bytes de Python usando la codificación UTF-32
   en orden de bytes nativo. La cadena siempre comienza con una marca
   BOM. El manejo de errores es "estricto". Retorna "NULL" si el códec
   provocó una excepción.

PyObject* PyUnicode_EncodeUTF32(const Py_UNICODE *s, Py_ssize_t size, const char *errors, int byteorder)
    *Return value: New reference.*

   Retorna un objeto de bytes de Python que contiene el valor
   codificado UTF-32 de los datos Unicode en *s*. La salida se escribe
   de acuerdo con el siguiente orden de bytes:

      byteorder == -1: little endian
      byteorder == 0:  native byte order (writes a BOM mark)
      byteorder == 1:  big endian

   Si *byteorder* es "0", la cadena de caracteres de salida siempre
   comenzará con la marca Unicode BOM (U+FEFF). En los otros dos
   modos, no se antepone ninguna marca BOM.

   Si "Py_UNICODE_WIDE" no está definido, los pares sustitutos se
   mostrarán como un único punto de código.

   Retorna "NULL" si el códec provocó una excepción.

   Deprecated since version 3.3, will be removed in version 3.11:
   Parte del viejo estilo de la API "Py_UNICODE"; por favor migrar
   para usar "PyUnicode_AsUTF32String()". o
   "PyUnicode_AsEncodedString()".


Códecs UTF-16
-------------

Estas son las APIs de códecs para UTF-16:

PyObject* PyUnicode_DecodeUTF16(const char *s, Py_ssize_t size, const char *errors, int *byteorder)
    *Return value: New reference.*

   Decodifica *size* bytes de una cadena de caracteres de búfer
   codificada UTF-16 y retorna el objeto Unicode correspondiente.
   *errors* (si no es "NULL") define el manejo de errores. Su valor
   predeterminado es "estricto".

   Si *byteorder* no es "NULL", el decodificador comienza a
   decodificar utilizando el orden de bytes dado:

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

   Si "*byteorder" es cero, y los primeros dos bytes de los datos de
   entrada son una marca de orden de bytes (BOM), el decodificador
   cambia a este orden de bytes y la BOM no se copia en la cadena de
   caracteres Unicode resultante. Si "*byteorder" es "-1" o "1",
   cualquier marca de orden de bytes se copia en la salida (donde dará
   como resultado un "\ufeff" o un carácter "\ufffe").

   Una vez completado, **byteorder* se establece en el orden de bytes
   actual al final de los datos de entrada.

   Si *byteorder* es "NULL", el códec se inicia en modo de orden
   nativo.

   Retorna "NULL" si el códec provocó una excepción.

PyObject* PyUnicode_DecodeUTF16Stateful(const char *s, Py_ssize_t size, const char *errors, int *byteorder, Py_ssize_t *consumed)
    *Return value: New reference.*

   Si *consumed* es "NULL", se comporta como
   "PyUnicode_DecodeUTF16()". Si *consumed* no es "NULL",
   "PyUnicode_DecodeUTF16Stateful()" no tratará las secuencias de
   bytes UTF-16 incompletas finales (como un número impar de bytes o
   un par sustituto dividido) como un error. Esos bytes no serán
   decodificados y la cantidad de bytes que han sido decodificados se
   almacenará en *consumed*.

PyObject* PyUnicode_AsUTF16String(PyObject *unicode)
    *Return value: New reference.*

   Retorna una cadena de bytes de Python usando la codificación UTF-16
   en orden de bytes nativo. La cadena siempre comienza con una marca
   BOM. El manejo de errores es "estricto". Retorna "NULL" si el códec
   provocó una excepción.

PyObject* PyUnicode_EncodeUTF16(const Py_UNICODE *s, Py_ssize_t size, const char *errors, int byteorder)
    *Return value: New reference.*

   Retorna un objeto de bytes de Python que contiene el valor
   codificado UTF-16 de los datos Unicode en *s*. La salida se escribe
   de acuerdo con el siguiente orden de bytes:

      byteorder == -1: little endian
      byteorder == 0:  native byte order (writes a BOM mark)
      byteorder == 1:  big endian

   Si *byteorder* es "0", la cadena de caracteres de salida siempre
   comenzará con la marca Unicode BOM (U+FEFF). En los otros dos
   modos, no se antepone ninguna marca BOM.

   Si se define "Py_UNICODE_WIDE", un solo valor de "Py_UNICODE" puede
   representarse como un par sustituto. Si no está definido, cada uno
   de los valores "Py_UNICODE" se interpreta como un carácter UCS-2.

   Retorna "NULL" si el códec provocó una excepción.

   Deprecated since version 3.3, will be removed in version 3.11:
   Parte del viejo estilo de la API "Py_UNICODE"; por favor migrar
   para usar "PyUnicode_AsUTF16String()". o
   "PyUnicode_AsEncodedString()".


Códecs UTF-7
------------

Estas son las APIs del códec UTF-7:

PyObject* PyUnicode_DecodeUTF7(const char *s, Py_ssize_t size, const char *errors)
    *Return value: New reference.*

   Crea un objeto Unicode decodificando *size* bytes de la cadena de
   caracteres codificada UTF-7 *s*. Retorna "NULL" si el códec provocó
   una excepción.

PyObject* PyUnicode_DecodeUTF7Stateful(const char *s, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
    *Return value: New reference.*

   Si *consumed* es "NULL", se comporta como "PyUnicode_DecodeUTF7()".
   Si *consumed* no es "NULL", las secciones UTF-7 base-64 incompletas
   no se tratarán como un error. Esos bytes no serán decodificados y
   la cantidad de bytes que han sido decodificados se almacenará en
   *consumed*.

PyObject* PyUnicode_EncodeUTF7(const Py_UNICODE *s, Py_ssize_t size, int base64SetO, int base64WhiteSpace, const char *errors)
    *Return value: New reference.*

   Codifica el búfer "Py_UNICODE" del tamaño dado usando UTF-7 y
   retorna un objeto de bytes de Python. Retorna "NULL" si el códec
   provocó una excepción.

   Si *base64SetO* no es cero, "Set O" (puntuación que no tiene un
   significado especial) se codificará en base-64. Si
   *base64WhiteSpace* no es cero, el espacio en blanco se codificará
   en base-64. Ambos se establecen en cero para el códec Python
   "utf-7".

   Deprecated since version 3.3, will be removed in version 3.11:
   Parte del viejo estilo de la API "Py_UNICODE"; por favor migrar
   para usar "PyUnicode_AsEncodedString()".


Códecs Unicode escapado
-----------------------

Estas son las APIs de códecs para Unicode escapado:

PyObject* PyUnicode_DecodeUnicodeEscape(const char *s, Py_ssize_t size, const char *errors)
    *Return value: New reference.*

   Crea un objeto Unicode decodificando *size* bytes de la cadena
   codificada Unicode escapada (*Unicode-Escape*) *s*. Retorna "NULL"
   si el códec provocó una excepción.

PyObject* PyUnicode_AsUnicodeEscapeString(PyObject *unicode)
    *Return value: New reference.*

   Codifica un objeto Unicode usando Unicode escapado (*Unicode-
   Escape*) y retorna el resultado como un objeto de bytes. El manejo
   de errores es "estricto". Retorna "NULL" si el códec provocó una
   excepción.

PyObject* PyUnicode_EncodeUnicodeEscape(const Py_UNICODE *s, Py_ssize_t size)
    *Return value: New reference.*

   Codifica el búfer "Py_UNICODE" del tamaño *size* dado utilizando
   Unicode escapado y retorna un objeto de bytes. Retorna "NULL" si el
   códec provocó una excepción.

   Deprecated since version 3.3, will be removed in version 3.11:
   Parte del viejo estilo de la API "Py_UNICODE"; por favor migrar
   para usar "PyUnicode_AsUnicodeEscapeString()".


Códecs para Unicode escapado en bruto
-------------------------------------

Estas son las API del códec Unicode escapado en bruto (*Raw Unicode
Escape*):

PyObject* PyUnicode_DecodeRawUnicodeEscape(const char *s, Py_ssize_t size, const char *errors)
    *Return value: New reference.*

   Crea un objeto Unicode decodificando *size* bytes de la cadena de
   caracteres codificada Unicode escapada en bruto (*Raw-Unicode-
   Escape*) *s*. Retorna "NULL" si el códec provocó una excepción.

PyObject* PyUnicode_AsRawUnicodeEscapeString(PyObject *unicode)
    *Return value: New reference.*

   Codifica un objeto Unicode usando Unicode escapado en bruto (*Raw-
   Unicode-Escape*) y retorna el resultado como un objeto de bytes. El
   manejo de errores es "estricto". Retorna "NULL" si el códec provocó
   una excepción.

PyObject* PyUnicode_EncodeRawUnicodeEscape(const Py_UNICODE *s, Py_ssize_t size)
    *Return value: New reference.*

   Codifica el búfer "Py_UNICODE" del tamaño *size* dado usando
   Unicode escapado en bruto (*Raw-Unicode-Escape*) y retorna un
   objeto de bytes. Retorna "NULL" si el códec provocó una excepción.

   Deprecated since version 3.3, will be removed in version 3.11:
   Parte del viejo estilo de la API "Py_UNICODE"; por favor migrar
   para usar "PyUnicode_AsRawUnicodeEscapeString()" o
   "PyUnicode_AsEncodedString()".


Códecs Latin-1
--------------

Estas son las API del códec Latin-1: Latin-1 corresponde a los
primeros 256 ordinales Unicode y solo estos son aceptados por los
códecs durante la codificación.

PyObject* PyUnicode_DecodeLatin1(const char *s, Py_ssize_t size, const char *errors)
    *Return value: New reference.*

   Crea un objeto Unicode decodificando *size* bytes de la cadena de
   caracteres codificada en latin-1 *s*. Retorna "NULL" si el códec
   provocó una excepción.

PyObject* PyUnicode_AsLatin1String(PyObject *unicode)
    *Return value: New reference.*

   Codifica un objeto Unicode usando Latin-1 y retorna el resultado
   como un objeto de bytes Python. El manejo de errores es "estricto".
   Retorna "NULL" si el códec provocó una excepción.

PyObject* PyUnicode_EncodeLatin1(const Py_UNICODE *s, Py_ssize_t size, const char *errors)
    *Return value: New reference.*

   Codifica el búfer "Py_UNICODE" del tamaño *size* dado usando
   Latin-1 y retorna un objeto de bytes de Python. Retorna "NULL" si
   el códec provocó una excepción.

   Deprecated since version 3.3, will be removed in version 3.11:
   Parte del viejo estilo de la API "Py_UNICODE"; por favor migrar
   para usar "PyUnicode_AsLatin1String()" o
   "PyUnicode_AsEncodedString()".


Códecs ASCII
------------

Estas son las API del códec ASCII. Solo se aceptan datos ASCII de 7
bits. Todos los demás códigos generan errores.

PyObject* PyUnicode_DecodeASCII(const char *s, Py_ssize_t size, const char *errors)
    *Return value: New reference.*

   Crea un objeto Unicode decodificando *size* bytes de la cadena de
   caracteres codificada ASCII *s*. Retorna "NULL" si el códec provocó
   una excepción.

PyObject* PyUnicode_AsASCIIString(PyObject *unicode)
    *Return value: New reference.*

   Codifica un objeto Unicode usando ASCII y retorna el resultado como
   un objeto de bytes de Python. El manejo de errores es "estricto".
   Retorna "NULL" si el códec provocó una excepción.

PyObject* PyUnicode_EncodeASCII(const Py_UNICODE *s, Py_ssize_t size, const char *errors)
    *Return value: New reference.*

   Codifica el búfer "Py_UNICODE" del tamaño *size* dado utilizando
   ASCII y retorna un objeto de bytes de Python. Retorna "NULL" si el
   códec provocó una excepción.

   Deprecated since version 3.3, will be removed in version 3.11:
   Parte del viejo estilo de la API "Py_UNICODE"; por favor migrar
   para usar "PyUnicode_AsASCIIString()" o
   "PyUnicode_AsEncodedString()".


Códecs de mapa de caracteres
----------------------------

Este códec es especial porque puede usarse para implementar muchos
códecs diferentes (y esto es lo que se hizo para obtener la mayoría de
los códecs estándar incluidos en el paquete "encodings"). El códec
utiliza mapeo para codificar y decodificar caracteres. Los objetos de
mapeo provistos deben soportar la interfaz de mapeo "__getitem__()";
Los diccionarios y las secuencias funcionan bien.

Estos son las API de códec de mapeo:

PyObject* PyUnicode_DecodeCharmap(const char *data, Py_ssize_t size, PyObject *mapping, const char *errors)
    *Return value: New reference.*

   Crea un objeto Unicode decodificando *size* bytes de la cadena de
   caracteres codificada *s* usando el objeto *mapping* dado. Retorna
   "NULL" si el códec provocó una excepción.

   Si *mapping* es "NULL", se aplicará la decodificación Latin-1. De
   lo contrario, *mapping* debe asignar bytes ordinales (enteros en el
   rango de 0 a 255) a cadenas de caracteres Unicode, enteros (que
   luego se interpretan como ordinales Unicode) o "None". Los bytes de
   datos sin asignar - los que causan un "LookupError", así como los
   que se asignan a "None", "0xFFFE" o "'\ ufffe'", se tratan como
   asignaciones indefinidas y causan un error

PyObject* PyUnicode_AsCharmapString(PyObject *unicode, PyObject *mapping)
    *Return value: New reference.*

   Codifica un objeto Unicode usando el objeto *mapping* dado y
   retorna el resultado como un objeto de bytes. El manejo de errores
   es "estricto". Retorna "NULL" si el códec provocó una excepción.

   El objeto *mapping* debe asignar enteros ordinales Unicode a
   objetos de bytes, enteros en el rango de 0 a 255 o "None". Los
   ordinales de caracteres no asignados (los que causan un
   "LookupError"), así como los asignados a "Ninguno", se tratan como
   "mapeo indefinido" y causan un error.

PyObject* PyUnicode_EncodeCharmap(const Py_UNICODE *s, Py_ssize_t size, PyObject *mapping, const char *errors)
    *Return value: New reference.*

   Codifica el búfer "Py_UNICODE" del tamaño *size* dado utilizando el
   objeto *mapping* dado y retorna el resultado como un objeto de
   bytes. Retorna "NULL" si el códec provocó una excepción.

   Deprecated since version 3.3, will be removed in version 3.11:
   Parte del viejo estilo de la API "Py_UNICODE"; por favor migrar
   para usar "PyUnicode_AsCharmapString()" o
   "PyUnicode_AsEncodedString()".

La siguiente API de códec es especial en que asigna Unicode a Unicode.

PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, const char *errors)
    *Return value: New reference.*

   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.

   La tabla de mapeo debe mapear enteros ordinales Unicode a enteros
   ordinales Unicode o "None" (causando la eliminación del carácter).

   Las tablas de mapeo solo necesitan proporcionar la interfaz
   "__getitem__()"; Los diccionarios y las secuencias funcionan bien.
   Los ordinales de caracteres no asignados (los que causan un
   "LookupError") se dejan intactos y se copian tal cual.

   *errors* tiene el significado habitual para los códecs. Puede ser
   "NULL", lo que indica que debe usar el manejo de errores
   predeterminado.

PyObject* PyUnicode_TranslateCharmap(const Py_UNICODE *s, Py_ssize_t size, PyObject *mapping, const char *errors)
    *Return value: New reference.*

   Traduce un búfer "Py_UNICODE" del tamaño *size* dado al aplicarle
   una tabla de *mapping* de caracteres y retornar el objeto Unicode
   resultante. Retorna "NULL" cuando el códec provocó una excepción.

   Deprecated since version 3.3, will be removed in version 3.11:
   Parte del viejo estilo de la API "Py_UNICODE"; por favor migrar
   para usar "PyUnicode_Translate()". o generic codec based API


Códecs MBCS para Windows
------------------------

Estas son las API de códec MBCS. Actualmente solo están disponibles en
Windows y utilizan los convertidores Win32 MBCS para implementar las
conversiones. Tenga en cuenta que MBCS (o DBCS) es una clase de
codificaciones, no solo una. La codificación de destino está definida
por la configuración del usuario en la máquina que ejecuta el códec.

PyObject* PyUnicode_DecodeMBCS(const char *s, Py_ssize_t size, const char *errors)
    *Return value: New reference.*

   Crea un objeto Unicode decodificando *size* bytes de la cadena de
   caracteres codificada con MBCS *s*. Retorna "NULL" si el códec
   provocó una excepción.

PyObject* PyUnicode_DecodeMBCSStateful(const char *s, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
    *Return value: New reference.*

   Si *consumed* es "NULL", se comporta como "PyUnicode_DecodeMBCS()".
   Si *consumed* no es "NULL", "PyUnicode_DecodeMBCSStateful()" no
   decodificará el byte inicial y el número de bytes que se han
   decodificado se almacenará en *consumed*.

PyObject* PyUnicode_AsMBCSString(PyObject *unicode)
    *Return value: New reference.*

   Codifica un objeto Unicode usando MBCS y retorna el resultado como
   un objeto de bytes de Python. El manejo de errores es "estricto".
   Retorna "NULL" si el códec provocó una excepción.

PyObject* PyUnicode_EncodeCodePage(int code_page, PyObject *unicode, const char *errors)
    *Return value: New reference.*

   Codifica el objeto Unicode utilizando la página de códigos
   especificada y retorna un objeto de bytes de Python. Retorna "NULL"
   si el códec provocó una excepción. Use la página de códigos
   "CP_ACP" para obtener el codificador MBCS.

   Nuevo en la versión 3.3.

PyObject* PyUnicode_EncodeMBCS(const Py_UNICODE *s, Py_ssize_t size, const char *errors)
    *Return value: New reference.*

   Codifica el búfer "Py_UNICODE" del tamaño *size* dado usando MBCS y
   retorna un objeto de bytes de Python. Retorna "NULL" si el códec
   provocó una excepción.

   Deprecated since version 3.3, will be removed in version 4.0: Parte
   del viejo estilo "Py_UNICODE" de la API; por favor migrar a
   "PyUnicode_AsMBCSString()", "PyUnicode_EncodeCodePage()" o
   "PyUnicode_AsEncodedString()".


Métodos & Ranuras (*Slots*)
---------------------------


Métodos y funciones de ranura (*Slot*)
======================================

Las siguientes API son capaces de manejar objetos Unicode y cadenas de
caracteres en la entrada (nos referimos a ellos como cadenas de
caracteres en las descripciones) y retorna objetos Unicode o enteros
según corresponda.

Todos retornan "NULL" o "-1" si ocurre una excepción.

PyObject* PyUnicode_Concat(PyObject *left, PyObject *right)
    *Return value: New reference.*

   Une dos cadenas de caracteres que dan una nueva cadena de
   caracteres Unicode.

PyObject* PyUnicode_Split(PyObject *s, PyObject *sep, Py_ssize_t maxsplit)
    *Return value: New reference.*

   Divide una cadena de caracteres dando una lista de cadenas de
   caracteres Unicode. Si *sep* es "NULL", la división se realizará en
   todas las subcadenas de espacios en blanco. De lo contrario, las
   divisiones ocurren en el separador dado. A lo sumo se realizarán
   *maxsplit* divisiones. Si es negativo, no se establece ningún
   límite. Los separadores no están incluidos en la lista resultante.

PyObject* PyUnicode_Splitlines(PyObject *s, int keepend)
    *Return value: New reference.*

   Divide una cadena de caracteres Unicode en los saltos de línea,
   retornando una lista de cadenas de caracteres Unicode. CRLF se
   considera un salto de línea. Si *keepend* es "0", los caracteres de
   salto de línea no se incluyen en las cadenas de caracteres
   resultantes.

PyObject* PyUnicode_Join(PyObject *separator, PyObject *seq)
    *Return value: New reference.*

   Une una secuencia de cadenas de caracteres usando el *separator*
   dado y retorna la cadena de caracteres Unicode resultante.

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

   Retorna "1" si *substr* coincide con "str[start:end]" en el final
   de cola dado (*direction* == "-1" significa hacer una coincidencia
   de prefijo, *direction* == "1" una coincidencia de sufijo), "0" de
   lo contrario. retorne "-1" si ocurrió un error.

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

   Retorna la primera posición de *substr* en "str[start:end]" usando
   la *direction* dada (*direction* == "1" significa hacer una
   búsqueda hacia adelante, *direction* == "-1" una búsqueda hacia
   atrás). El valor de retorno es el índice de la primera
   coincidencia; un valor de "-1" indica que no se encontró ninguna
   coincidencia, y "-2" indica que se produjo un error y se ha
   establecido una excepción.

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

   Retorna la primera posición del carácter *ch* en "str[inicio:fin]"
   usando la *direction* dada (*direction* == "1" significa hacer una
   búsqueda hacia adelante, *direction* == "-1" una búsqueda hacia
   atrás). El valor de retorno es el índice de la primera
   coincidencia; un valor de "-1" indica que no se encontró ninguna
   coincidencia, y "-2" indica que se produjo un error y se ha
   establecido una excepción.

   Nuevo en la versión 3.3.

   Distinto en la versión 3.7: *start* y *end* ahora están ajustados
   para comportarse como "str[start:end]".

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

   Retorna el número de ocurrencias no superpuestas de *substr* en
   "str[start:end]". Retorna "-1" si ocurrió un error.

PyObject* PyUnicode_Replace(PyObject *str, PyObject *substr, PyObject *replstr, Py_ssize_t maxcount)
    *Return value: New reference.*

   Reemplaza como máximo *maxcount* ocurrencias de *substr* en *str*
   con *replstr* y retorna el objeto Unicode resultante. *maxcount* ==
   "-1" significa reemplazar todas las ocurrencias.

int PyUnicode_Compare(PyObject *left, PyObject *right)

   Compara dos cadenas de caracteres y retorna "-1", "0", "1" para
   menor que, igual y mayor que, respectivamente.

   Esta función retorna "-1" en caso de falla, por lo que se debe
   llamar a "PyErr_Occurred()" para verificar si hay errores.

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

   Compare un objeto Unicode, *uni*, con *string* y retorna "-1", "0",
   "1" para menor que, igual y mayor que, respectivamente. Es mejor
   pasar solo cadenas de caracteres codificadas en ASCII, pero la
   función interpreta la cadena de entrada como ISO-8859-1 si contiene
   caracteres no ASCII.

   Esta función no genera excepciones.

PyObject* PyUnicode_RichCompare(PyObject *left, PyObject *right, int op)
    *Return value: New reference.*

   Comparación enriquecida de dos cadenas de caracteres Unicode y
   retorna uno de los siguientes:

   * "NULL" en caso de que se produzca una excepción

   * "Py_True" o "Py_False" para comparaciones exitosas

   * "Py_NotImplemented" en caso que se desconozca la combinación de
     tipos.

   Los posibles valores para *op* son "Py_GT", "Py_GE", "Py_EQ",
   "Py_NE", "Py_LT", y "Py_LE".

PyObject* PyUnicode_Format(PyObject *format, PyObject *args)
    *Return value: New reference.*

   Retorna un nuevo objeto de cadena de caracteres desde *format* y
   *args*; esto es análogo al "format % args".

int PyUnicode_Contains(PyObject *container, PyObject *element)

   Comprueba si *element* está contenido en *container* y retorna
   verdadero o falso en consecuencia.

   *element* tiene que convertir a una cadena de caracteres Unicode.
   Se retorna "-1" si hubo un error.

void PyUnicode_InternInPlace(PyObject **string)

   Interna el argumento **string* en su lugar. El argumento debe ser
   la dirección de una variable de puntero que apunta a un objeto
   Unicode de cadena de caracteres Python. Si hay una cadena de
   caracteres interna existente que es igual a **string*, establece
   **string* (disminuyendo el recuento de referencias del objeto de
   cadena de caracteres anterior e incrementando el recuento de
   referencias del objeto de cadena de caracteres interna), de lo
   contrario deja solo **string* y lo interna (incrementando su
   recuento de referencias). (Aclaración: a pesar de que se habla
   mucho sobre el recuento de referencias, piense en esta función como
   neutral de recuento de referencia; usted es el propietario del
   objeto después de la llamada si y solo si lo tenía antes de la
   llamada).

PyObject* PyUnicode_InternFromString(const char *v)
    *Return value: New reference.*

   Una combinación de "PyUnicode_FromString()" y
   "PyUnicode_InternInPlace()", que retorna un nuevo objeto de cadena
   de caracteres Unicode que ha sido creado internamente o una nueva
   referencia("propia") a un objeto de cadena de caracteres interno
   anterior con el mismo valor
