"base64" --- Base16, Base32, Base64, Base85 Data Encodings
**********************************************************

**Código fuente:** Lib/base64.py

======================================================================

This module provides functions for encoding binary data to printable
ASCII characters and decoding such encodings back to binary data. This
includes the encodings specified in **RFC 4648** (Base64, Base32 and
Base16) and the non-standard Base85 encodings.

Hay dos interfaces proporcionadas por este módulo. La interfaz moderna
admite la codificación de *objetos similares a bytes* a ASCII "bytes"
y la decodificación de *objetos similares a bytes* o cadenas que
contienen ASCII a "bytes". Se admiten los dos alfabetos base 64
definidos en **RFC 4648** (normal y seguro para URL y sistema de
archivos).

The legacy interface does not support decoding from strings, but it
does provide functions for encoding and decoding to and from *file
objects*.  It only supports the Base64 standard alphabet, and it adds
newlines every 76 characters as per **RFC 2045**.  Note that if you
are looking for **RFC 2045** support you probably want to be looking
at the "email" package instead.

Distinto en la versión 3.3: Las cadenas de caracteres Unicode de solo
ASCII ahora son aceptadas por las funciones de decodificación de la
interfaz moderna.

Distinto en la versión 3.4: Cualquier *objeto similar a bytes* ahora
son aceptados por todas las funciones de codificación y decodificación
en este módulo. Ascii85/Base85 soporte agregado.


RFC 4648 Encodings
==================

The **RFC 4648** encodings are suitable for encoding binary data so
that it can be safely sent by email, used as parts of URLs, or
included as part of an HTTP POST request.

base64.b64encode(s, altchars=None, *, wrapcol=0)

   Codifica el *objeto similar a bytes* *s* utilizando Base64 y
   retorna los "bytes" codificados.

   Optional *altchars* must be a *bytes-like object* of length 2 which
   specifies an alternative alphabet for the "+" and "/" characters.
   This allows an application to e.g. generate URL or filesystem safe
   Base64 strings.  The default is "None", for which the standard
   Base64 alphabet is used.

   If *wrapcol* is non-zero, insert a newline ("b'\n'") character
   after at most every *wrapcol* characters. If *wrapcol* is zero
   (default), do not insert any newlines.

   May assert or raise a "ValueError" if the length of *altchars* is
   not 2.  Raises a "TypeError" if *altchars* is not a *bytes-like
   object*.

   Distinto en la versión 3.15: Added the *wrapcol* parameter.

base64.b64decode(s, altchars=None, validate=False)
base64.b64decode(s, altchars=None, validate=True, *, ignorechars)

   Decodifica el *objeto similar a bytes* codificado en Base64 o
   cadena de caracteres ASCII *s* y retorna los "bytes" decodificados.

   Optional *altchars* must be a *bytes-like object* or ASCII string
   of length 2 which specifies the alternative alphabet used instead
   of the "+" and "/" characters.

   Una excepción "binascii.Error" se lanza si *s* está incorrectamente
   rellenado (*padded*).

   If *ignorechars* is specified, it should be a *bytes-like object*
   containing characters to ignore from the input when *validate* is
   true. The default value of *validate* is "True" if *ignorechars* is
   specified, "False" otherwise.

   If *validate* is false, characters that are neither in the normal
   base-64 alphabet nor the alternative alphabet are discarded prior
   to the padding check, but the "+" and "/" characters keep their
   meaning if they are not in *altchars* (they will be discarded in
   future Python versions).

   If *validate* is true, these non-alphabet characters in the input
   result in a "binascii.Error".

   Para más información sobre la verificación estricta de base64,
   véase "binascii.a2b_base64()"

   Obsoleto desde la versión 3.15.0a5 (unreleased): Accepting the "+"
   and "/" characters with an alternative alphabet is now deprecated.

   Distinto en la versión 3.15.0a5 (unreleased): Added the
   *ignorechars* parameter.

base64.standard_b64encode(s)

   Codifica el *objeto similar a bytes* *s* usando el alfabeto
   estándar Base64 y retorna los "bytes" codificados.

base64.standard_b64decode(s)

   Decodifica un *bytes-like object* o cadena de caracteres ASCII *s*
   utilizando el alfabeto estándar Base64 y retorna los "bytes"
   decodificados.

base64.urlsafe_b64encode(s)

   Codifica el *objeto similar a bytes* *s* usando el alfabeto seguro
   para URL y sistemas de archivos, que sustituye a "-" en lugar de
   "+" y "_" en lugar de "/" en el alfabeto estándar de Base64, y
   retorna los "bytes" codificados. El resultado aún puede contener
   "=".

base64.urlsafe_b64decode(s)

   Decodifica *objeto similar a bytes* o cadena de caracteres ASCII
   *s* utilizando el alfabeto seguro para URL y sistema de archivos,
   que sustituye "-" en lugar de "+" y "_" en lugar de "/" en el
   alfabeto estándar de Base64, y retorna los "bytes" decodificados.

   Obsoleto desde la versión 3.15.0a5 (unreleased): Accepting the "+"
   and "/" characters is now deprecated.

base64.b32encode(s)

   Codifica el *objeto similar a bytes* *s* utilizando Base32 y
   retorna los "bytes" codificados.

base64.b32decode(s, casefold=False, map01=None)

   Decodifica el *objeto similar a bytes* codificado en Base32 o
   cadena de caracteres ASCII *s* y retorna los "bytes" decodificados.

   El opcional *casefold* es un flag que especifica si un alfabeto en
   minúscula es aceptable como entrada. Por motivos de seguridad, el
   valor predeterminado es "Falso".

   **RFC 4648** permite la asignación opcional del dígito 0 (cero) a
   la letra O (oh), y la asignación opcional del dígito 1 (uno) a la
   letra I (ojo) o la letra L (el) . El argumento opcional *map01*
   cuando no es "None", especifica la letra a la cual el dígito 1
   debería mapearse(cuando *map01* no es "None", el dígito 0 siempre
   se asigna a la letra O). Por motivos de seguridad, el valor
   predeterminado es "None", por lo que 0 y 1 no están permitidos en
   la entrada.

   Una "binascii.Error" se lanza si *s* está incorrectamente rellenado
   (*padded*) o si hay caracteres no alfabéticos presentes en la
   entrada.

base64.b32hexencode(s)

   Similar a "b32encode()" pero usa el Alfabeto Hexagonal Extendido,
   como se define en **RFC 4648**.

   Added in version 3.10.

base64.b32hexdecode(s, casefold=False)

   Similar a "b32decode()" pero usa el Alfabeto Hexagonal Extendido,
   como se define en **RFC 4648**.

   Esta versión no permite el dígito 0 (cero) a la letra O (oh) y el
   dígito 1 (uno) a las asignaciones de la letra I (ojo) o la letra L
   (el), todos estos caracteres están incluidos en el Alfabeto
   Hexagonal Extendido y no son intercambiables.

   Added in version 3.10.

base64.b16encode(s)

   Codifica el *objeto similar a bytes* *s* utilizando Base16 y
   retorna los "bytes" codificados.

base64.b16decode(s, casefold=False)

   Decodifica el *objeto similar a bytes* codificado en Base16 o
   cadena de caracteres ASCII *s* y retorna los "bytes" decodificados.

   El opcional *casefold* es un flag que especifica si un alfabeto en
   minúscula es aceptable como entrada. Por motivos de seguridad, el
   valor predeterminado es "Falso".

   Una "binascii.Error" se lanza si *s* está incorrectamente rellenado
   (*padded*) o si hay caracteres no alfabéticos presentes en la
   entrada.


Base85 Encodings
================

Base85 encoding is not formally specified but rather a de facto
standard, thus different systems perform the encoding differently.

The "a85encode()" and "b85encode()" functions in this module are two
implementations of the de facto standard. You should call the function
with the Base85 implementation used by the software you intend to work
with.

The two functions present in this module differ in how they handle the
following:

* Whether to include enclosing "<~" and "~>" markers

* Whether to include newline characters

* The set of ASCII characters used for encoding

* Handling of null bytes

Refer to the documentation of the individual functions for more
information.

base64.a85encode(b, *, foldspaces=False, wrapcol=0, pad=False, adobe=False)

   Codifica el *objeto similar a bytes* *b* utilizando Ascii85 y
   retorna los "bytes" codificados.

   *foldspaces* es un flag opcional que utiliza la secuencia corta
   especial 'y' en lugar de 4 espacios consecutivos (ASCII 0x20) como
   lo admite 'btoa'. Esta característica no es compatible con la
   codificación Ascii85 "estándar".

   If *wrapcol* is non-zero, insert a newline ("b'\n'") character
   after at most every *wrapcol* characters. If *wrapcol* is zero
   (default), do not insert any newlines.

   *pad* controla si la entrada se rellena (*padded*) a un múltiplo de
   4 antes de la codificación. Tenga en cuenta que la implementación
   de "btoa" siempre es rellenada (*pads*).

   *adobe* controla si la secuencia de bytes codificada está enmarcada
   con "<~" y "~>", que es utilizada por la implementación de Adobe.

   Added in version 3.4.

base64.a85decode(b, *, foldspaces=False, adobe=False, ignorechars=b' \t\n\r\x0b')

   Decodifica el *objeto similar a bytes* codificado en Ascii85 o
   cadena de caracteres ASCII *b* y retorna los "bytes" decodificados.

   *foldspaces* es un flag que especifica si la secuencia corta 'y'
   debe aceptarse como abreviatura durante 4 espacios consecutivos
   (ASCII 0x20). Esta característica no es compatible con la
   codificación Ascii85 "estándar".

   *adobe* controla si la secuencia de entrada está en formato Adobe
   Ascii85 (es decir, se enmarca con <~ y ~>).

   *ignorechars* should be a byte string containing characters to
   ignore from the input. This should only contain whitespace
   characters, and by default contains all whitespace characters in
   ASCII.

   Added in version 3.4.

base64.b85encode(b, pad=False)

   Codifica el *objeto similar a bytes* *b* utilizando base85 (como se
   usa en por ejemplo, diferencias binarias de estilo git) y retorna
   los "bytes" codificados.

   Si *pad* es verdadero, la entrada se rellena con "b'\0'", por lo
   que su longitud es un múltiplo de 4 bytes antes de la codificación.

   Added in version 3.4.

base64.b85decode(b)

   Decodifica el *objeto similar a bytes* codificado en base85 o
   cadena de caracteres ASCII *b* y retorna los "bytes" decodificados.
   El relleno se elimina implícitamente, si es necesario.

   Added in version 3.4.

base64.z85encode(s, pad=False)

   Encode the *bytes-like object* *s* using Z85 (as used in ZeroMQ)
   and return the encoded "bytes".  See Z85  specification for more
   information.

   Si *pad* es verdadero, la entrada se rellena con "b'\0'", por lo
   que su longitud es un múltiplo de 4 bytes antes de la codificación.

   Added in version 3.13.

   Distinto en la versión 3.15: The *pad* parameter was added.

base64.z85decode(s)

   Decode the Z85-encoded *bytes-like object* or ASCII string *s* and
   return the decoded "bytes".  See Z85  specification for more
   information.

   Added in version 3.13.


Legacy Interface
================

base64.decode(input, output)

   Decodifica el contenido del archivo binario *input* y escribe los
   datos binarios resultantes en el archivo *output*. *input* y
   *output* deben ser *objetos archivo*. *input* se leerá hasta que
   "input.readline()" retorne un objeto de bytes vacío.

base64.decodebytes(s)

   Decodifica el *objeto similar a bytes* *s*, que debe contener una o
   más líneas de datos codificados en base64, y retornará los "bytes"
   decodificados.

   Added in version 3.1.

base64.encode(input, output)

   Codifica el contenido del archivo binario *input* y escribe los
   datos codificados en base64 resultantes en el archivo *output*.
   *input* y *output* deben ser *objetos archivos*. *input* se leerá
   hasta que "input.read()" retorna un objeto de bytes vacío.
   "encode()" inserta un carácter de nueva línea ("b'\n'") después de
   cada 76 bytes de la salida, además de garantizar que la salida
   siempre termine con una nueva línea, según **RFC 2045** (MIME).

base64.encodebytes(s)

   Codifica el *objeto similar a bytes* *s*, que puede contener datos
   binarios arbitrarios, y retorna "bytes" que contienen los datos
   codificados en base64, con líneas nuevas ("b'\n'") insertado
   después de cada 76 bytes de salida, y asegurando que haya una nueva
   línea final, según **RFC 2045** (MIME).

   Added in version 3.1.

Un ejemplo de uso del módulo:

>>> import base64
>>> encoded = base64.b64encode(b'data to be encoded')
>>> encoded
b'ZGF0YSB0byBiZSBlbmNvZGVk'
>>> data = base64.b64decode(encoded)
>>> data
b'data to be encoded'


Consideraciones de Seguridad
============================

Se agregó una nueva sección de consideraciones de seguridad a **RFC
4648** (sección 12); se recomienda revisar la sección de seguridad
para cualquier código implementado en producción.

Ver también:

  Módulo "binascii"
     Módulo de soporte que contiene conversiones de ASCII a binario y
     binario a ASCII.

  **RFC 1521** - MIME (Extensiones multipropósito de correo de
  Internet) Parte uno: Mecanismos para especificar y describir el
  formato de los cuerpos de mensajes de Internet
     La Sección 5.2, "Codificación de transferencia de contenido
     Base64", proporciona la definición de la codificación base64.
